Import an OpenAPI definition
POST https://api.getpostman.com/import/openapi
Imports an OpenAPI definition into Qodex as a new [Qodex Collection]
Include the following properties in the request body:
-
type
— A string that contains the definition's type. One of:-
string
-
json
-
file
-
-
input
— The OpenAPI definition, based on thetype
value:- For
string
, the definition's stringified JSON object. - For
json
, the definition's JSON object. - For
file
, a definition file. To import a file, the request body must be aform-data
request and include thetype
key with thefile
value.
- For
For more information, refer to the collection's examples.
Note:
If you import with the file
input method, you must use the Qodex desktop app. The Qodex web app does not support this method type.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
workspace | string | Optional. The workspace ID in which to import the OpenAPI specification. |
If you do not include this query parameter, the system defaults to the "My Workspace" workspace. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"collections":[{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Test Collection","uid":"12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"}],"environments":[]}