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 the type 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 a form-data request and include the type key with the file value.

You can include the following additional properties in the request body:

• options — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Qodex's OpenAPI 3.0 to Qodex Collection v2.1.0 Converter OPTIONS documentation. These properties are case-sensitive.

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

If you do not include this query parameter, the system defaults to the "My Workspace" workspace. |

HEADERS

RESPONSES

status: OK

{"collections":[{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Test Collection","uid":"12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"}],"environments":[]}