Import an OpenAPI definition

POST

/import/openapi

POST

/import/openapi

curl -X POST https://api.postman.com/import/openapi \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "input": {
    "components": {
      "schemas": {
        "Error": {
          "properties": {
            "message": {
              "description": "A human readable error message",
              "type": "string"
            }
          },
          "required": [
            "message"
          ],
          "type": "object"
        },
        "Spacecraft": {
          "properties": {
            "description": {
              "type": "string"
            },
            "id": {
              "description": "The unique identifier of a spacecraft",
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "type": {
              "enum": [
                "capsule",
                "probe",
                "satellite",
                "spaceplane",
                "station"
              ],
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "type"
          ],
          "type": "object"
        },
        "SpacecraftId": {
          "description": "The unique identifier of a spacecraft",
          "type": "string"
        }
      },
      "securitySchemes": {
        "ApiKey": {
          "in": "header",
          "name": "X-Api-Key",
          "type": "apiKey"
        }
      }
    },
    "info": {
      "contact": {
        "name": "Jon"
      },
      "description": "Buy or rent spacecrafts",
      "title": "Sample API",
      "version": "1.0.0"
    },
    "openapi": "3.0.0",
    "paths": {
      "/spacecrafts/{spacecraftId}": {
        "get": {
          "responses": {
            "200": {
              "content": {
                "application/json": {
                  "schema": {
                    "properties": {
                      "description": {
                        "type": "string"
                      },
                      "id": {
                        "description": "The unique identifier of a spacecraft",
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "capsule",
                          "probe",
                          "satellite",
                          "spaceplane",
                          "station"
                        ],
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "type"
                    ],
                    "type": "object"
                  }
                }
              },
              "description": "The spacecraft corresponding to the provided `spacecraftId`"
            },
            "404": {
              "content": {
                "application/json": {
                  "schema": {
                    "properties": {
                      "message": {
                        "description": "A human readable error message",
                        "type": "string"
                      }
                    },
                    "required": [
                      "message"
                    ],
                    "type": "object"
                  }
                }
              },
              "description": "No spacecraft found for the provided `spacecraftId`"
            },
            "500": {
              "content": {
                "application/json": {
                  "schema": {
                    "properties": {
                      "message": {
                        "description": "A human readable error message",
                        "type": "string"
                      }
                    },
                    "required": [
                      "message"
                    ],
                    "type": "object"
                  }
                }
              },
              "description": "Unexpected error"
            }
          },
          "summary": "Read a spacecraft"
        },
        "parameters": [
          {
            "description": "The unique identifier of the spacecraft",
            "in": "path",
            "name": "spacecraftId",
            "required": true,
            "schema": {
              "description": "The unique identifier of a spacecraft",
              "type": "string"
            }
          }
        ]
      }
    },
    "security": [
      {
        "ApiKey": []
      }
    ],
    "servers": [
      {
        "url": "example.com"
      }
    ]
  },
  "type": "json"
}'

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

Imports an OpenAPI definition into Postman as a new Postman Collection.

Note:

This endpoint has a rate limit of 10 requests per 10 seconds.
The Postman web app does not support the file input method type.
If you do not include the workspace query parameter, the system imports the definition into the oldest personal Internal workspace you own.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

workspacestringRequired

The workspace's ID.

Request

This endpoint expects an object.

JSON SchemaobjectRequired

JSON StringifiedobjectRequired

Response

Successful Response

collectionslist of objectsOptional

A list of the collections created from the imported OpenAPI definition.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error