Get a spec's definition

GET

/specs/:specId/definitions

GET

/specs/:specId/definitions

$ curl https://api.postman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/definitions \
>      -H "x-api-key: <apiKey>"

1 "{\n    \"openapi\": \"3.0.0\",\n    \"servers\": [\n        {\n            \"url\": \"example.com\"\n        }\n    ],\n    \"info\": {\n        \"contact\": {\n            \"name\": \"\"\n        },\n        \"version\": \"1.0.0\",\n        \"title\": \"Sample API\",\n        \"description\": \"Buy or rent spacecrafts\"\n    },\n    \"paths\": {\n        \"/spacecrafts/{spacecraftId}\": {\n            \"parameters\": [\n                {\n                    \"name\": \"spacecraftId\",\n                    \"description\": \"The unique identifier of the spacecraft\",\n                    \"in\": \"path\",\n                    \"required\": true,\n                    \"schema\": {\n                        \"$ref\": \"#/components/schemas/SpacecraftId\"\n                    }\n                }\n            ],\n            \"get\": {\n                \"summary\": \"Read a spacecraft\",\n                \"responses\": {\n                    \"200\": {\n                        \"description\": \"The spacecraft corresponding to the provided `spacecraftId`\",\n                        \"content\": {\n                            \"application/json\": {\n                                \"schema\": {\n                                    \"$ref\": \"#/components/schemas/Spacecraft\"\n                                }\n                            }\n                        }\n                    },\n                    \"404\": {\n                        \"description\": \"No spacecraft found for the provided `spacecraftId`\",\n                        \"content\": {\n                            \"application/json\": {\n                                \"schema\": {\n                                    \"$ref\": \"#/components/schemas/Error\"\n                                }\n                            }\n                        }\n                    },\n                    \"500\": {\n                        \"description\": \"Unexpected error\",\n                        \"content\": {\n                            \"application/json\": {\n                                \"schema\": {\n                                    \"$ref\": \"#/components/schemas/Error\"\n                                }\n                            }\n                        }\n                    }\n                }\n            },\n            \"post\": {\n                \"summary\": \"A short summary of what the operation does.\",\n                \"responses\": {\n                    \"200\": {\n                        \"description\": \"A short description of the response.\",\n                        \"content\": {\n                            \"application/json\": {\n                                \"schema\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    }\n                }\n            }\n        },\n        \"/pathName\": {\n            \"summary\": \"A short summary intended to apply to all operations in this path.\",\n            \"get\": {\n                \"summary\": \"A short summary of what the operation does.\",\n                \"responses\": {\n                    \"200\": {\n                        \"description\": \"A short description of the response.\",\n                        \"content\": {\n                            \"application/json\": {\n                                \"schema\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    },\n    \"components\": {\n        \"schemas\": {\n            \"SpacecraftId\": {\n                \"description\": \"The unique identifier of a spacecraft\",\n                \"type\": \"string\"\n            },\n            \"Spacecraft\": {\n                \"type\": \"object\",\n                \"required\": [\n                    \"id\",\n                    \"name\",\n                    \"type\"\n                ],\n                \"properties\": {\n                    \"id\": {\n                        \"$ref\": \"#/components/schemas/SpacecraftId\"\n                    },\n                    \"name\": {\n                        \"type\": \"string\"\n                    },\n                    \"type\": {\n                        \"type\": \"string\",\n                        \"enum\": [\n                            \"capsule\",\n                            \"probe\",\n                            \"satellite\",\n                            \"spaceplane\",\n                            \"station\"\n                        ]\n                    },\n                    \"description\": {\n                        \"type\": \"string\"\n                    }\n                }\n            },\n            \"Error\": {\n                \"type\": \"object\",\n                \"required\": [\n                    \"message\"\n                ],\n                \"properties\": {\n                    \"message\": {\n                        \"description\": \"A human readable error message\",\n                        \"type\": \"string\"\n                    }\n                }\n            }\n        },\n        \"securitySchemes\": {\n            \"ApiKey\": {\n                \"type\": \"apiKey\",\n                \"in\": \"header\",\n                \"name\": \"X-Api-Key\"\n            }\n        }\n    },\n    \"security\": [\n        {\n            \"ApiKey\": []\n        }\n    ]\n}"

Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

specIdstringRequired

The spec's ID.

Response

Successful Response

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error