POST /import/openapi
This endpoint allows you to import external API specifications into Postman.
Currently, this endpoint only supports the OpenAPI specification, for which the importType will be openapi.
On a successful import, the response will be an array with each element contaning id, name and uid of entities created.
Supported types:
- string
- json
- file
The input parameter should be defined based on the type.
To import a file, request body must be form-data with
typeparam set tofile.
Note: Refer to examples for different scenarios.
Requires API Key as
X-Api-Keyrequest header.
Servers
- https://api.getpostman.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
input |
Object | No | |
input.openapi |
String | No | |
input.info |
Object | No | |
input.info.license |
Object | No | |
input.info.license.name |
String | No | |
input.info.version |
String | No | |
input.info.title |
String | No | |
input.servers[] |
Array | No | |
input.servers[].url |
String | No | |
input.paths |
Object | No | |
input.paths./pets |
Object | No | |
input.paths./pets.get |
Object | No | |
input.paths./pets.get.parameters[] |
Array | No | |
input.paths./pets.get.parameters[].name |
String | No | |
input.paths./pets.get.parameters[].description |
String | No | |
input.paths./pets.get.parameters[].required |
Boolean | No | |
input.paths./pets.get.parameters[].schema |
Object | No | |
input.paths./pets.get.parameters[].schema.format |
String | No | |
input.paths./pets.get.parameters[].schema.type |
String | No | |
input.paths./pets.get.parameters[].in |
String | No | |
input.paths./pets.get.operationId |
String | No | |
input.paths./pets.get.responses |
Object | No | |
input.paths./pets.get.responses.default |
Object | No | |
input.paths./pets.get.responses.default.description |
String | No | |
input.paths./pets.get.responses.default.content |
Object | No | |
input.paths./pets.get.responses.default.content.application/json |
Object | No | |
input.paths./pets.get.responses.default.content.application/json.schema |
Object | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties |
Object | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties.message |
Object | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties.message.type |
String | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties.code |
Object | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties.code.format |
String | No | |
input.paths./pets.get.responses.default.content.application/json.schema.properties.code.type |
String | No | |
input.paths./pets.get.responses.default.content.application/json.schema.required[] |
Array | No | |
input.paths./pets.get.summary |
String | No | |
type |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.