REST query import
Use query import to create multiple REST queries at once from API definitions.
Supported formats
- OpenAPI 2.0 / Swagger 2.0 (JSON or YAML)
- OpenAPI 3.0 / Swagger 3.0 (JSON or YAML)
- cURL
Import flow (file or raw text)
- Open Settings > Connections > APIs
- Open the target connection
- Click Open in API Editor
- Click Import
- Choose input source:
- File: upload spec file
- Raw text: paste spec text
- Click Import
- Review the imported queries
- Open key queries and click Send
- Save any adjusted queries
Security validation
When importing from a URL, Budibase applies the same security hardening and validation rules as the REST integration itself. This includes:
- Blacklist validation: Preventing imports from blocked internal or sensitive hostnames.
- DNS Rebinding protection: Request pinning to validated IP addresses to prevent host-switching during the import process.
- Protocol enforcement: Only secure
http:andhttps:protocols are permitted.
Post-import hardening checklist
- Rename generic query names
- Confirm auth config per query
- Confirm base URL and path compatibility with your environment
- Add or correct bindings for runtime values
- Confirm request body formats
- Validate the schema output after the first successful run
Importing from Postman
Postman collections should be converted to OpenAPI first.
- Export collection JSON from Postman
- Convert using
postman2openapi - Import converted output into API Editor
- Validate each imported write endpoint carefully
Common import issues
- Unknown or unsupported fields in the spec: simplify or clean the OpenAPI file before import
- Imported query fails auth: map to the correct connection auth config
- Paths duplicate the base URL: correct the path or full URL handling
Related guides
Updated 4 months ago
Did this page help you?