openapi: 3.1.0 info: title: Postman Specs API version: 1.0.0 description: 'Operations tagged specs across 2 of this provider''s published API definitions: postman-api-openapi.yml, postman-specs-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com tags: - name: specs paths: /apis/{apiId}/spec-migrations: get: operationId: getMigrationStatus summary: Get status of API Builder to Spec Hub migration description: Returns the status of an API Builder definition's migration to Spec Hub. tags: - specs parameters: - name: apiId in: path description: The API's ID. required: true schema: $ref: '#/components/schemas/apiId' - name: x-api-key in: header required: true schema: type: string - name: Accept in: header description: The `application/vnd.api.v10+json` request header required to use the endpoint. required: true schema: $ref: '#/components/schemas/v10Accept' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMigrationStatus' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/getMigrationStatus400Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetMigrationStatusRequestForbiddenError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetMigrationStatusRequestInternalServerError' post: operationId: migrateApiToSpecHub summary: Migrate API Builder API to Spec Hub description: 'Migrates an API Builder definition to a [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview) specification. You can migrate the definition to an existing workspace, or create a new workspace to migrate the definition into. On success, this returns an HTTP `202 Created` response. You can use the GET `/apis/{apiId}/spec-migrations` endpoint to check the migration status. **Note:** - This returns an HTTP `200 OK` response if the given API ID isn''t an API Builder definition. - To migrate a Git-linked API Builder definition to Spec Hub, you must create a new workspace. Migration to an existing workspace isn''t supported. ' tags: - specs parameters: - name: apiId in: path description: The API's ID. required: true schema: $ref: '#/components/schemas/apiId' - name: x-api-key in: header required: true schema: type: string - name: Accept in: header description: The `application/vnd.api.v10+json` request header required to use the endpoint. required: true schema: $ref: '#/components/schemas/v10Accept' responses: '200': description: Empty API Migration content: application/json: schema: $ref: '#/components/schemas/migrateToSpecHubResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/MigrateApiToSpecHubRequestBadRequestError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/MigrateApiToSpecHubRequestForbiddenError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/MigrateApiToSpecHubRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/migrateApiToSpecHub' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /collections/{collectionUid}/generations/{elementType}: get: operationId: getGeneratedCollectionSpecs summary: Get generated spec description: Gets the API specification generated for the given collection. tags: - specs parameters: - name: collectionUid in: path description: The collection's unique ID. required: true schema: $ref: '#/components/schemas/collectionUid' - name: elementType in: path description: The `spec` value. required: true schema: $ref: '#/components/schemas/elementTypeSpec' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getGeneratedCollectionSpecs' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetGeneratedCollectionSpecsRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetGeneratedCollectionSpecsRequestInternalServerError' post: operationId: generateSpecFromCollection summary: Generate spec from collection description: Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status. tags: - specs parameters: - name: collectionUid in: path description: The collection's unique ID. required: true schema: $ref: '#/components/schemas/collectionUid' - name: elementType in: path description: The `spec` value. required: true schema: $ref: '#/components/schemas/elementTypeSpec' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateTaskResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GenerateSpecFromCollectionRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '423': description: Locked content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GenerateSpecFromCollectionRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/generateSpecFromCollection' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /collections/{collectionUid}/synchronizations: put: operationId: syncCollectionWithSpec summary: Sync collection with spec description: 'Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given spec ID. ' tags: - specs parameters: - name: collectionUid in: path description: The collection's unique ID. required: true schema: $ref: '#/components/schemas/collectionUid' - name: specId in: query description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateTaskResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/SyncCollectionWithSpecRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/SyncCollectionWithSpecRequestInternalServerError' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /{elementType}/{elementId}/tasks/{taskId}: get: operationId: getAsyncSpecTaskStatus summary: Get status of an async spec task description: Gets the status of an asynchronous API specification creation task. tags: - specs parameters: - name: elementType in: path description: The element to filter results by. required: true schema: $ref: '#/components/schemas/elementType' - name: elementId in: path description: The element's ID. required: true schema: $ref: '#/components/schemas/elementId' - name: taskId in: path description: The task's ID. required: true schema: $ref: '#/components/schemas/taskId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Specs_getAsyncSpecTaskStatus_Response_200' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetAsyncSpecTaskStatusRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetAsyncSpecTaskStatusRequestInternalServerError' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs: get: operationId: getAllSpecs summary: Get all specs description: Gets all API specifications in a workspace. tags: - specs parameters: - name: workspaceId in: query description: The workspace's ID. required: true schema: $ref: '#/components/schemas/workspaceId' - name: cursor in: query description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter. required: false schema: $ref: '#/components/schemas/cursor' - name: limit in: query description: The maximum number of rows to return in the response. required: false schema: $ref: '#/components/schemas/limit' default: 10 - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAllSpecs' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetAllSpecsRequestForbiddenError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetAllSpecsRequestInternalServerError' post: operationId: createSpec summary: Create a spec description: 'Creates an API specification in Postman''s [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications. - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 12 MB in size. ' tags: - specs parameters: - name: workspaceId in: query description: The workspace's ID. required: true schema: $ref: '#/components/schemas/workspaceId' - name: x-api-key in: header required: true schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/createSpecResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/CreateSpecRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CreateSpecRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/createSpec' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}: get: operationId: getSpec summary: Get a spec description: Gets information about an API specification. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/specData' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecRequestInternalServerError' delete: operationId: deleteSpec summary: Delete a spec description: Deletes an API specification. On success, this returns an HTTP `204 No Content` response. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '204': description: No Content content: application/json: schema: type: object properties: {} '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/DeleteSpecRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/DeleteSpecRequestInternalServerError' patch: operationId: updateSpecProperties summary: Update a spec's properties description: Updates an API specification's properties, such as its name. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Spec Updated content: application/json: schema: $ref: '#/components/schemas/updateSpecPropertiesResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/UpdateSpecPropertiesRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/UpdateSpecPropertiesRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/updateSpecProperties' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/collections/{collectionId}/sync-options: patch: operationId: updateSpecSyncOptions summary: Update spec sync options description: Updates the [sync options](https://learning.postman.com/docs/design-apis/specifications/generate-collections/#configure-sync-settings) for a specification's generated collection. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: collectionId in: path description: The collection's ID. required: true schema: $ref: '#/components/schemas/collectionId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/apiSpecSyncOptions' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/UpdateSpecSyncOptionsRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/UpdateSpecSyncOptionsRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/apiSpecSyncOptions' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/definitions: get: operationId: getSpecDefinition summary: Get a spec's definition description: Gets the complete contents of an OpenAPI or AsyncAPI specification's definition. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Specs_getSpecDefinition_Response_200' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecDefinitionRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecDefinitionRequestInternalServerError' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/files: get: operationId: getSpecFiles summary: Get a spec's files description: Gets all the files in an API specification. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecFiles' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecFilesRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecFilesRequestInternalServerError' post: operationId: createSpecFile summary: Create a spec file description: 'Creates a file for an OpenAPI or a protobuf 2 or 3 specification. **Note:** - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Creating a spec file assigns it the `DEFAULT` file type. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 10 MB in size. ' tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateSpecFileResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/CreateSpecFileRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CreateSpecFileRequestInternalServerError' requestBody: description: Create Spec File content: application/json: schema: $ref: '#/components/schemas/createSpecFile' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/files/{filePath}: get: operationId: getSpecFile summary: Get a spec file description: Gets the contents of an API specification's file. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: filePath in: path description: The path to the file. required: true schema: $ref: '#/components/schemas/filePath' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecFile' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecFileRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecFileRequestInternalServerError' delete: operationId: deleteSpecFile summary: Delete a spec file description: Deletes a file in an API specification. On success, this returns an HTTP `204 No Content` response. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: filePath in: path description: The path to the file. required: true schema: $ref: '#/components/schemas/filePath' - name: x-api-key in: header required: true schema: type: string responses: '204': description: No Content content: application/json: schema: type: object properties: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/DeleteSpecFileRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/DeleteSpecFileRequestInternalServerError' patch: operationId: updateSpecFile summary: Update a spec file description: 'Updates a file for an OpenAPI or protobuf 2 or 3 specification. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time. - Multi-file specifications can only have one root file. - When updating a file type to `ROOT`, the previous root file is updated to the `DEFAULT` file type. - Files cannot exceed a maximum of 10 MB in size. ' tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: filePath in: path description: The path to the file. required: true schema: $ref: '#/components/schemas/filePath' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateSpecFileResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/UpdateSpecFileRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/UpdateSpecFileRequestInternalServerError' requestBody: description: Update Spec File content: application/json: schema: $ref: '#/components/schemas/updateSpecFile' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/generations/{elementType}: get: operationId: getSpecCollections summary: Get a spec's generated collections description: Gets all of an API specification's generated collections. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: elementType in: path description: The `collection` element type. required: true schema: $ref: '#/components/schemas/elementTypeCollection' - name: limit in: query description: The maximum number of rows to return in the response. required: false schema: $ref: '#/components/schemas/limit' default: 10 - name: cursor in: query description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter. required: false schema: $ref: '#/components/schemas/cursor' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecCollections' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecCollectionsRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecCollectionsRequestInternalServerError' post: operationId: generateCollection summary: Generate a collection from spec description: Creates a collection from the given OpenAPI 2.0, 3.0, or 3.1 specification or Smithy specification. The response contains a polling link to the task status. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: elementType in: path description: The `collection` element type. required: true schema: $ref: '#/components/schemas/elementTypeCollection' - name: x-api-key in: header required: true schema: type: string responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateTaskResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GenerateCollectionRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '423': description: Locked content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GenerateCollectionRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/generateCollection' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/synchronizations: put: operationId: syncSpecWithCollection summary: Sync spec with collection description: 'Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given specification ID. ' tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: collectionUid in: query description: The collection's unique ID. required: true schema: $ref: '#/components/schemas/collectionUid' - name: x-api-key in: header required: true schema: type: string responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateTaskResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/SyncSpecWithCollectionRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/SyncSpecWithCollectionRequestInternalServerError' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/version-tags/{tagId}/files: get: operationId: getSpecVersionTag summary: Get a version tag description: Gets information about a specification's version tag. The response returns a snapshot of a specification at a point in time that lets you track changes to your specifications over time. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: tagId in: path description: The version tag's ID. required: true schema: $ref: '#/components/schemas/tagId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecVersionTag' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecVersionTagRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecVersionTagRequestInternalServerError' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com /specs/{specId}/version-tags: get: operationId: getSpecVersionTags summary: Get a specification's version tags description: Gets a list of a specification's version tags. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: cursor in: query description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter. required: false schema: $ref: '#/components/schemas/cursor' - name: limit in: query description: The maximum number of rows to return in the response. required: false schema: $ref: '#/components/schemas/limit' default: 10 - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecVersionTags' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecVersionTagsRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecVersionTagsRequestInternalServerError' post: operationId: createSpecVersionTag summary: Create a version tag description: 'Creates a version tag for a specification. Version tags are snapshots of a specification at a point in time that let you to track changes to your specifications over time. **Note:** Conflicts can occur if you try to create a version tag for a changelog group that already has a version tag. To resolve this, make new changes to the specification to create a new changelog group, then create a version tag on that new changelog group. ' tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: x-api-key in: header required: true schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/createSpecVersionTagResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/CreateSpecVersionTagRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/CreateSpecVersionTagRequestInternalServerError' requestBody: content: application/json: schema: $ref: '#/components/schemas/createSpecVersionTag' servers: - url: https://api.postman.com description: https://api.postman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com components: schemas: MigrateApiToSpecHub400ErrorTitleMessageError: type: object properties: title: type: string description: A short summary of the problem. message: type: string description: The error message. title: MigrateApiToSpecHub400ErrorTitleMessageError GenerateSpecFromCollectionFormat: type: string enum: - JSON - YAML description: The format of the API specification. title: GenerateSpecFromCollectionFormat GetSpecFilesRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecFilesRequestForbiddenError migrateApiToSpecHubExistingWorkspace: type: object properties: workspaceId: type: string description: The ID of an existing workspace to migrate the definition to. required: - workspaceId title: migrateApiToSpecHubExistingWorkspace SpecFileDataType: type: string enum: - ROOT - DEFAULT description: 'The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. ' title: SpecFileDataType GetSpecFilesRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecFilesRequestInternalServerError CommonErrorTypeTitleDetailStatusType: oneOf: - type: string format: uri-reference - type: string title: CommonErrorTypeTitleDetailStatusType SyncCollectionWithSpecRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail' title: SyncCollectionWithSpecRequestForbiddenError GetGeneratedCollectionSpecsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetGeneratedCollectionSpecsRequestForbiddenError GetSpecVersionTagsDataItems: type: object properties: id: type: string description: The version tag's ID. name: type: string description: The version tag's name. description: Information about the version tag. title: GetSpecVersionTagsDataItems GetSpecVersionTagsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecVersionTagsRequestInternalServerError DeleteSpecFileRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: DeleteSpecFileRequestInternalServerError updateSpecProperties: type: object properties: name: type: string description: The spec's name. required: - name title: updateSpecProperties metaData: type: object properties: nextCursor: type: - string - 'null' format: base64 description: The pagination cursor that points to the next record in the results set. description: The response's meta information for paginated results. title: metaData commonErrorTypeTitleDetail: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. detail: $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail' description: Information about the error. title: commonErrorTypeTitleDetail getGeneratedCollectionSpecs: type: object properties: specs: type: array items: $ref: '#/components/schemas/generatedSpecCollectionData' description: A list of the collection's generated API specficiations. meta: $ref: '#/components/schemas/metaData' title: getGeneratedCollectionSpecs migrateApiToSpecHub400ErrorTitleMessageDetails: type: object properties: error: $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageDetailsError' title: migrateApiToSpecHub400ErrorTitleMessageDetails createSpecVersionTag: type: object properties: name: type: string description: The version tag's name. required: - name title: createSpecVersionTag GetAsyncTaskStatusMeta: type: object properties: action: type: string description: The task's action. model: $ref: '#/components/schemas/GetAsyncTaskStatusMetaModel' description: The model for which the task is performing the operation. description: The response's non-standard meta information. title: GetAsyncTaskStatusMeta CreateSpecRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: CreateSpecRequestInternalServerError getSpecFiles: type: object properties: files: type: array items: $ref: '#/components/schemas/specFileData' description: A list of the API specification's files. meta: $ref: '#/components/schemas/metaData' description: Information about the specification's files. title: getSpecFiles GetSpecDefinitionRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecDefinitionRequestForbiddenError getMigrationStatus400Error: type: object properties: error: $ref: '#/components/schemas/GetMigrationStatus400ErrorError' title: getMigrationStatus400Error createSpecResponse: type: object properties: name: type: string description: The API specification's name. type: $ref: '#/components/schemas/specType' id: type: string description: The specification's ID. createdAt: type: string format: date-time description: The date and time at which the specification file was created. updatedAt: type: string format: date-time description: The date and time at which the file was last updated. createdBy: type: integer description: The user ID of the user that created the file. updatedBy: type: integer description: The user ID of the user that last updated the specification file. title: createSpecResponse limit: type: integer default: 10 title: limit CreateSpecVersionTagRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: CreateSpecVersionTagRequestInternalServerError generatedSpecCollectionData: type: object properties: id: type: string description: The collection's ID. name: type: string description: The collection's name. state: $ref: '#/components/schemas/GeneratedSpecCollectionDataState' description: The sync state of the collection and its API specification. createdAt: type: string format: date-time description: The date and time at which the collection was generated. updatedAt: type: string format: date-time description: The date and time at which the collection was updated. createdBy: type: integer description: The user ID of the user that generated the collection. updatedBy: type: integer description: The ID of the user who updated the collection. description: Information about the collection's API specification. title: generatedSpecCollectionData CreateSpecFilesItemsOneOf0Type: type: string enum: - DEFAULT - ROOT description: 'The type of file. This property is required when creating multi-file specifications: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' title: CreateSpecFilesItemsOneOf0Type GetSpecVersionTagDataItems: type: object properties: id: type: string description: The file's ID. name: type: string description: The file's name. updatedBy: type: string description: The ID of the user who updated the file. createdAt: type: string format: date-time description: The date and time at which the file was created. updatedAt: type: string format: date-time description: The date and time at which the file was updated. createdBy: type: string description: The user ID of the user that created the file. type: $ref: '#/components/schemas/GetSpecVersionTagDataItemsType' description: The file's type. path: type: string description: The file's path. fileType: $ref: '#/components/schemas/GetSpecVersionTagDataItemsFileType' description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. This file contains a subset of the OpenAPI structure, such as specific components or paths. This value doesn''t return for folders. ' content: type: string description: The file's content. Folders don't return this property. parentId: type: string description: The file's parent folder ID. This property is absent for ROOT-level files. description: Information about the element. title: GetSpecVersionTagDataItems updateSpecFile: type: object properties: name: type: string description: The file's name. type: $ref: '#/components/schemas/UpdateSpecFileType' description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' content: type: string description: The specification's stringified contents. description: You must pass one of the accepted values in this request body. Also, this request body does not accept multiple properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time. title: updateSpecFile getSpecCollections: type: object properties: collections: type: array items: $ref: '#/components/schemas/specCollectionData' description: A list of the API specification's generated collections. meta: $ref: '#/components/schemas/metaData' title: getSpecCollections getSpecFile: type: object properties: id: type: string description: The file's ID. name: type: string description: The file's name. path: type: string description: The file's path. createdBy: type: integer description: The user ID of the user that created the file. updatedBy: type: integer description: The ID of the user who updated the file. createdAt: type: string format: date-time description: The date and time at which the file was created. updatedAt: type: string format: date-time description: The date and time at which the file was updated. type: $ref: '#/components/schemas/GetSpecFileType' description: 'The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. ' content: type: string description: The file's stringified contents. description: Information about the API specification file. title: getSpecFile getAllSpecs: type: object properties: meta: $ref: '#/components/schemas/metaData' specs: type: array items: $ref: '#/components/schemas/GetAllSpecsSpecsItems' description: A list of API specifications. title: getAllSpecs GenerateCollectionRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GenerateCollectionRequestInternalServerError UpdateSpecSyncOptionsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: UpdateSpecSyncOptionsRequestForbiddenError SyncSpecWithCollectionRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: SyncSpecWithCollectionRequestForbiddenError UpdateSpecFileRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: UpdateSpecFileRequestInternalServerError UpdateSpecFileType: type: string enum: - DEFAULT - ROOT description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' title: UpdateSpecFileType CreateSpecVersionTagResponseData: type: object properties: id: type: string description: The version tag's ID. name: type: string description: The version tag's name. description: Information about the created version tag. title: CreateSpecVersionTagResponseData DeleteSpecRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: DeleteSpecRequestForbiddenError GetAllSpecsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetAllSpecsRequestForbiddenError migrateGitConnectedApiToSpecHub: type: object properties: workspaceInfo: $ref: '#/components/schemas/MigrateGitConnectedApiToSpecHubWorkspaceInfo' description: Information about the new workspace. gitInfo: $ref: '#/components/schemas/MigrateGitConnectedApiToSpecHubGitInfo' description: Information about the connected remote Git mono-repo. required: - workspaceInfo - gitInfo title: migrateGitConnectedApiToSpecHub getSpecVersionTag: type: object properties: data: type: array items: $ref: '#/components/schemas/GetSpecVersionTagDataItems' description: A list of the version tag's files and folders. title: getSpecVersionTag getMigrationStatusDetails: oneOf: - $ref: '#/components/schemas/GetMigrationStatusDetails0' - $ref: '#/components/schemas/GetMigrationStatusDetails1' title: getMigrationStatusDetails migrateToSpecHubResponse: type: object properties: message: type: string description: The operation's message. success: type: boolean description: If true, the migration succeeded. title: migrateToSpecHubResponse GeneratedSpecCollectionDataState: type: string enum: - in-sync - out-of-sync - sync-in-progress description: The sync state of the collection and its API specification. title: GeneratedSpecCollectionDataState MigrateGitConnectedApiToSpecHubWorkspaceInfo: type: object properties: name: type: string description: The name of the workspace to create and migrate the definition to. required: - name description: Information about the new workspace. title: MigrateGitConnectedApiToSpecHubWorkspaceInfo CreateUpdateSpecFileResponseType: type: string enum: - DEFAULT - ROOT default: DEFAULT description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' title: CreateUpdateSpecFileResponseType GetSpecFileRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecFileRequestInternalServerError GenerateCollectionOptionsIndentCharacter: type: string enum: - Tab - Space default: Space description: The option for setting the indentation character type. title: GenerateCollectionOptionsIndentCharacter CreateSpecVersionTagRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: CreateSpecVersionTagRequestForbiddenError GetAsyncTaskStatusMetaModel: type: string enum: - collection - spec description: The model for which the task is performing the operation. title: GetAsyncTaskStatusMetaModel CommonErrorNameMessageError: type: object properties: name: type: string description: The error name. message: type: string description: The error message. description: Information about the error. title: CommonErrorNameMessageError elementTypeCollection: type: string enum: - collection title: elementTypeCollection collectionUid: type: string format: uid title: collectionUid migrateApiToSpecHub: oneOf: - $ref: '#/components/schemas/migrateApiToSpecHubExistingWorkspace' - $ref: '#/components/schemas/migrateApiToSpecHubNewWorkspace' - $ref: '#/components/schemas/migrateGitConnectedApiToSpecHub' title: migrateApiToSpecHub meta: type: object properties: nextCursor: type: - string - 'null' description: The pagination cursor that points to the next record in the results set. title: meta UpdateSpecFileRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: UpdateSpecFileRequestForbiddenError GetAsyncSpecTaskStatusRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetAsyncSpecTaskStatusRequestForbiddenError MigrateGitConnectedApiToSpecHubGitInfo: type: object properties: path: type: string description: The directory path in the remote mono-repo containing the API's collections and definitions. This property expects an absolute path and only contains alphanumeric characters, slashes, hyphens, underscores, and periods. It cannot contain path traversal sequences (\..\). required: - path description: Information about the connected remote Git mono-repo. title: MigrateGitConnectedApiToSpecHubGitInfo GetSpecFileType: type: string enum: - ROOT - DEFAULT description: 'The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. ' title: GetSpecFileType commonErrorTypeTitleDetailStatusInstance: type: object properties: type: type: string format: uri-reference description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. title: type: string description: A short summary of the problem. detail: type: string description: An explanation about the problem. status: type: integer description: The HTTP status code generated by the origin server. instance: type: string description: The URI reference that identifies the specific occurrence of the problem. title: commonErrorTypeTitleDetailStatusInstance AsyncSpecTaskStatusResourcesItems: type: object properties: id: type: string description: The ID of the assigned resource. url: type: string description: The task's assigned resource URL. title: AsyncSpecTaskStatusResourcesItems commonErrorNameMessage: type: object properties: error: $ref: '#/components/schemas/CommonErrorNameMessageError' description: Information about the error. title: commonErrorNameMessage CreateSpecFilesItems: oneOf: - $ref: '#/components/schemas/CreateSpecFilesItems0' - $ref: '#/components/schemas/CreateSpecFilesItems1' title: CreateSpecFilesItems createSpecVersionTagResponse: type: object properties: data: $ref: '#/components/schemas/CreateSpecVersionTagResponseData' description: Information about the created version tag. title: createSpecVersionTagResponse getAsyncTaskStatus: type: object properties: meta: $ref: '#/components/schemas/GetAsyncTaskStatusMeta' description: The response's non-standard meta information. details: $ref: '#/components/schemas/asyncSpecTaskStatus' status: $ref: '#/components/schemas/GetAsyncTaskStatusStatus' description: The task's current status. title: getAsyncTaskStatus filePath: type: string title: filePath MigrateApiToSpecHub400ErrorTypeNameMessageTitleError: type: object properties: type: type: string description: A short summary of the problem. name: type: string description: The error name. message: type: string description: The error message. title: type: string description: A short summary of the problem. title: MigrateApiToSpecHub400ErrorTypeNameMessageTitleError GenerateCollectionOptionsRequestNameSource: type: string enum: - Fallback - URL default: Fallback description: 'Determines how the generated collection''s requests are named. If the `Fallback` value is passed, then the request is named after one of the following values in the schema: - `summary` - `operationId` - `description` - `url` ' title: GenerateCollectionOptionsRequestNameSource MigrateApiToSpecHubRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: MigrateApiToSpecHubRequestInternalServerError GetAsyncTaskStatusStatus: type: string enum: - pending - failed - completed description: The task's current status. title: GetAsyncTaskStatusStatus createSpec: type: object properties: name: type: string description: The specification's name. type: $ref: '#/components/schemas/specType' files: type: array items: $ref: '#/components/schemas/CreateSpecFilesItems' description: A list of the specification's files and their contents. required: - name - type - files title: createSpec GetAsyncSpecTaskStatusRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetAsyncSpecTaskStatusRequestInternalServerError MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails: type: object properties: workspaceId: type: string description: The workspace's ID. description: Information about the error. title: MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails taskId: type: string title: taskId collectionId: type: string title: collectionId generateSpecFromCollection: type: object properties: name: type: string description: The API specification's name. type: $ref: '#/components/schemas/GenerateSpecFromCollectionType' description: The specification's type. format: $ref: '#/components/schemas/GenerateSpecFromCollectionFormat' description: The format of the API specification. required: - name title: generateSpecFromCollection migrateApiToSpecHubNewWorkspace: type: object properties: workspaceInfo: $ref: '#/components/schemas/MigrateApiToSpecHubNewWorkspaceWorkspaceInfo' description: Information about the new workspace. required: - workspaceInfo title: migrateApiToSpecHubNewWorkspace CreateSpecFileRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: CreateSpecFileRequestInternalServerError CreateSpecFilesItems1: type: object properties: path: type: string description: The file's path. Accepts .json, .yaml, .proto, .graphql, and .smithy file types. content: type: string description: The file's stringified contents. required: - path - content title: CreateSpecFilesItems1 migrateApiToSpecHub400ErrorTitleMessage: type: object properties: error: $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageError' title: migrateApiToSpecHub400ErrorTitleMessage UpdateSpecPropertiesRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: UpdateSpecPropertiesRequestInternalServerError GenerateSpecFromCollectionType: type: string enum: - OPENAPI:2.0 - OPENAPI:3.0 - OPENAPI:3.1 description: The specification's type. title: GenerateSpecFromCollectionType GenerateCollectionRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GenerateCollectionRequestForbiddenError GetGeneratedCollectionSpecsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetGeneratedCollectionSpecsRequestInternalServerError workspaceId: type: string title: workspaceId DeleteSpecFileRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: DeleteSpecFileRequestForbiddenError GetSpecRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecRequestInternalServerError GetSpecCollectionsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecCollectionsRequestInternalServerError GetMigrationStatusDetails1: type: object properties: reason: type: string description: The reason the migration failed. description: Information about the migration. title: GetMigrationStatusDetails1 elementId: oneOf: - type: string - type: string format: uid title: elementId specType: type: string enum: - OPENAPI:2.0 - OPENAPI:3.0 - OPENAPI:3.1 - ASYNCAPI:2.0 - ASYNCAPI:3.0 - PROTOBUF:2 - PROTOBUF:3 - GRAPHQL - SMITHY:2.0 description: The type of API specification. title: specType cursor: type: string title: cursor fileFormat: type: string enum: - json - yaml - proto - graphql - smithy description: The specification's file format. title: fileFormat GetSpecDefinitionRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecDefinitionRequestInternalServerError specFileData: type: object properties: id: type: string description: The file's ID. path: type: string description: The file's path. name: type: string description: The file's name. createdBy: type: integer description: The user ID of the user that created the file. updatedBy: type: integer description: The ID of the user who updated the file. createdAt: type: string format: date-time description: The date and time at which the file was created. updatedAt: type: string format: date-time description: The date and time at which the file was updated. type: $ref: '#/components/schemas/SpecFileDataType' description: 'The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. ' description: Information about the API specification file. title: specFileData GetSpecVersionTagDataItemsFileType: type: string enum: - ROOT - DEFAULT description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. This file contains a subset of the OpenAPI structure, such as specific components or paths. This value doesn''t return for folders. ' title: GetSpecVersionTagDataItemsFileType updateSpecPropertiesResponse: type: object properties: id: type: string description: The specification's ID. type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The ID of the user that created the specification. updatedBy: type: integer description: The ID of the user that last updated the specification. createdAt: type: string format: date-time description: The date and time at which the specification was created. updatedAt: type: string format: date-time description: The date and time at which the specification was last updated. name: type: string description: The API specification's name. title: updateSpecPropertiesResponse GetAllSpecsSpecsItems: type: object properties: id: type: string description: The specification's ID. name: type: string description: The specification's name. type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The user ID of the user that created the specification. updatedBy: type: integer description: The ID of the user who updated the specification. createdAt: type: string format: date-time description: The date and time at which the specification was created. updatedAt: type: string format: date-time description: The date and time at which the specification was updated. description: Information about the API specification. title: GetAllSpecsSpecsItems getAsyncTaskStatusFailed: type: object properties: details: type: string description: Details about the generation error. meta: $ref: '#/components/schemas/GetAsyncTaskStatusFailedMeta' description: The response's non-standard meta information. status: $ref: '#/components/schemas/GetAsyncTaskStatusFailedStatus' description: The task's current status. title: getAsyncTaskStatusFailed GetMigrationStatusRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetMigrationStatusRequestForbiddenError GetMigrationStatusStatus: type: string enum: - COMPLETED - FAILED description: The status of the migration. title: GetMigrationStatusStatus GenerateSpecFromCollectionRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GenerateSpecFromCollectionRequestInternalServerError GetSpecVersionTagRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecVersionTagRequestForbiddenError generateCollectionOptions: type: object properties: requestNameSource: $ref: '#/components/schemas/GenerateCollectionOptionsRequestNameSource' default: Fallback description: 'Determines how the generated collection''s requests are named. If the `Fallback` value is passed, then the request is named after one of the following values in the schema: - `summary` - `operationId` - `description` - `url` ' indentCharacter: $ref: '#/components/schemas/GenerateCollectionOptionsIndentCharacter' default: Space description: The option for setting the indentation character type. parametersResolution: type: string default: Schema description: Generated collections use examples for parameter generation by default. Any existing collections generated using the schema parameter generation will continue to sync using their existing strategy. folderStrategy: $ref: '#/components/schemas/GenerateCollectionOptionsFolderStrategy' default: Paths description: Whether to create folders based on the specification's `paths` or `tags` properties. includeAuthInfoInExample: type: boolean default: true description: If true, include the authentication parameters in the example request. enableOptionalParameters: type: boolean default: true description: If true, enables optional parameters in the collection and its requests. keepImplicitHeaders: type: boolean default: false description: If true, keep the implicit headers from the OpenAPI specification, which are removed by default. includeDeprecated: type: boolean default: true description: If true, includes all deprecated operations, parameters, and properties in generated collection. alwaysInheritAuthentication: type: boolean default: false description: Whether authentication details should be included in all requests, or always inherited from the collection. nestedFolderHierarchy: type: boolean default: false description: If true, creates subfolders in the generated collection based on the order of the endpoints' tags. description: The advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive. title: generateCollectionOptions GenerateSpecFromCollectionRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GenerateSpecFromCollectionRequestForbiddenError apiId: type: string title: apiId generateCollection: type: object properties: name: type: string description: The generated collection's name. options: $ref: '#/components/schemas/generateCollectionOptions' required: - name - options title: generateCollection MigrateApiToSpecHubRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: MigrateApiToSpecHubRequestForbiddenError SyncCollectionWithSpecRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: SyncCollectionWithSpecRequestInternalServerError commonErrorTypeTitleMessageDetail: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. message: type: string description: The error message. detail: type: object additionalProperties: description: Any type description: Information about the error. title: commonErrorTypeTitleMessageDetail GetSpecRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecRequestForbiddenError ApiSpecSyncOptionsSyncOptions: type: object properties: syncExamples: type: boolean default: true description: If true, updates made to examples in the specification or to example values in the generated collection stay synchronized. deleteOrphanedRequests: type: boolean default: true description: If true, deletes requests and endpoints that no longer exist in the source during sync. description: Information about the specification sync options. title: ApiSpecSyncOptionsSyncOptions Specs_getAsyncSpecTaskStatus_Response_200: oneOf: - $ref: '#/components/schemas/getAsyncTaskStatus' - $ref: '#/components/schemas/getAsyncTaskStatusFailed' title: Specs_getAsyncSpecTaskStatus_Response_200 getSpecVersionTags: type: object properties: data: type: array items: $ref: '#/components/schemas/GetSpecVersionTagsDataItems' description: A list of the specification's version tags. meta: $ref: '#/components/schemas/meta' title: getSpecVersionTags GenerateCollectionOptionsFolderStrategy: type: string enum: - Paths - Tags default: Paths description: Whether to create folders based on the specification's `paths` or `tags` properties. title: GenerateCollectionOptionsFolderStrategy tagId: type: string title: tagId SyncSpecWithCollectionRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: SyncSpecWithCollectionRequestInternalServerError SpecCollectionDataState: type: string enum: - in-sync - out-of-sync - sync-in-progress description: The sync state of the collection and its API specification. title: SpecCollectionDataState getMigrationStatus: type: object properties: status: $ref: '#/components/schemas/GetMigrationStatusStatus' description: The status of the migration. details: $ref: '#/components/schemas/getMigrationStatusDetails' title: getMigrationStatus createUpdateSpecFileResponse: type: object properties: createdAt: type: string format: date-time description: The date and time at which the file was created. createdBy: type: integer description: The user ID of the user that created the file. id: type: string description: The file's ID. path: type: string description: The file's path. updatedAt: type: string format: date-time description: The date and time at which the file was updated. updatedBy: type: integer description: The ID of the user who updated the file. type: $ref: '#/components/schemas/CreateUpdateSpecFileResponseType' default: DEFAULT description: 'The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' description: Information about the API specification file. title: createUpdateSpecFileResponse MigrateApiToSpecHub400ErrorTitleMessageDetailsError: type: object properties: title: type: string description: A short summary of the problem. details: $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails' description: Information about the error. message: type: string description: The error message. title: MigrateApiToSpecHub400ErrorTitleMessageDetailsError Specs_getSpecDefinition_Response_200: type: object properties: {} description: Empty response body title: Specs_getSpecDefinition_Response_200 GetSpecVersionTagRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecVersionTagRequestInternalServerError CreateSpecFileRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: CreateSpecFileRequestForbiddenError CreateSpecRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: CreateSpecRequestForbiddenError v10Accept: type: string enum: - application/vnd.api.v10+json title: v10Accept MigrateApiToSpecHubNewWorkspaceWorkspaceInfo: type: object properties: name: type: string description: The name of the workspace to create and migrate the definition to. required: - name description: Information about the new workspace. title: MigrateApiToSpecHubNewWorkspaceWorkspaceInfo GetSpecVersionTagsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecVersionTagsRequestForbiddenError generateTaskResponse: type: object properties: taskId: type: string description: The created task ID. You can use this ID to track the status of the task. url: type: string description: The URL to get or poll the status of a generated spec task. title: generateTaskResponse specCollectionData: type: object properties: id: type: string description: The collection's ID. name: type: string description: The collection's name. state: $ref: '#/components/schemas/SpecCollectionDataState' description: The sync state of the collection and its API specification. createdAt: type: string format: date-time description: The date and time at which the collection was generated. updatedAt: type: string format: date-time description: The date and time at which the collection was updated. createdBy: type: integer description: The user ID of the user that generated the collection. description: Information about the API specification's collection. title: specCollectionData GetAsyncTaskStatusFailedMeta: type: object properties: action: type: string description: The task's action. model: $ref: '#/components/schemas/GetAsyncTaskStatusFailedMetaModel' description: The model for which the task is performing the operation. description: The response's non-standard meta information. title: GetAsyncTaskStatusFailedMeta MigrateApiToSpecHubRequestBadRequestError: oneOf: - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessage' - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessageDetails' - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTypeNameMessageTitle' title: MigrateApiToSpecHubRequestBadRequestError GetMigrationStatusDetails0: type: object properties: workspaceId: type: string description: The ID of the workspace the definition was migrated to. description: Information about the migration. title: GetMigrationStatusDetails0 UpdateSpecPropertiesRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: UpdateSpecPropertiesRequestForbiddenError GetSpecFileRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecFileRequestForbiddenError commonErrorTypeTitleDetailStatus: type: object properties: type: $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType' title: type: string description: A short summary of the problem. detail: type: string description: Information about the error. status: type: integer description: The error's HTTP status code. title: commonErrorTypeTitleDetailStatus elementType: type: string enum: - collections - specs title: elementType GetSpecVersionTagDataItemsType: type: string enum: - FILE - FOLDER description: The file's type. title: GetSpecVersionTagDataItemsType GetMigrationStatusRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetMigrationStatusRequestInternalServerError asyncSpecTaskStatus: type: object properties: resources: type: array items: $ref: '#/components/schemas/AsyncSpecTaskStatusResourcesItems' description: Information about the task's resources. title: asyncSpecTaskStatus CreateSpecFilesItems0: type: object properties: path: type: string description: The file's path. Accepts .json, .yaml, and .proto types. content: type: string description: The file's stringified contents. type: $ref: '#/components/schemas/CreateSpecFilesItemsOneOf0Type' description: 'The type of file. This property is required when creating multi-file specifications: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. ' required: - path - content - type title: CreateSpecFilesItems0 GetMigrationStatus400ErrorError: type: object properties: name: type: string description: The error name. message: type: string description: The error message. details: type: object additionalProperties: description: Any type description: Information about the error. title: GetMigrationStatus400ErrorError elementTypeSpec: type: string enum: - spec title: elementTypeSpec apiSpecSyncOptions: type: object properties: syncOptions: $ref: '#/components/schemas/ApiSpecSyncOptionsSyncOptions' description: Information about the specification sync options. title: apiSpecSyncOptions GetAsyncTaskStatusFailedMetaModel: type: string enum: - collection - spec description: The model for which the task is performing the operation. title: GetAsyncTaskStatusFailedMetaModel specData: type: object properties: id: type: string description: The specification's ID. fileFormat: $ref: '#/components/schemas/fileFormat' name: type: string description: The specification's name. type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The user ID of the user that created the specification. updatedBy: type: integer description: The ID of the user who updated the specification. createdAt: type: string format: date-time description: The date and time at which the specification was created. updatedAt: type: string format: date-time description: The date and time at which the specification was updated. description: Information about the API specification. title: specData DeleteSpecRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: DeleteSpecRequestInternalServerError GetSpecCollectionsRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecCollectionsRequestForbiddenError UpdateSpecSyncOptionsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: UpdateSpecSyncOptionsRequestInternalServerError CommonErrorTypeTitleDetailDetail: oneOf: - type: string - type: object additionalProperties: description: Any type description: Information about the error. title: CommonErrorTypeTitleDetailDetail specId: type: string title: specId createSpecFile: type: object properties: path: type: string description: The file's path. Accepts JSON or YAML files. content: type: string description: The file's stringified contents. required: - path - content title: createSpecFile GetAsyncTaskStatusFailedStatus: type: string enum: - failed description: The task's current status. title: GetAsyncTaskStatusFailedStatus migrateApiToSpecHub400ErrorTypeNameMessageTitle: type: object properties: error: $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTypeNameMessageTitleError' title: migrateApiToSpecHub400ErrorTypeNameMessageTitle GetAllSpecsRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetAllSpecsRequestInternalServerError securitySchemes: PostmanApiKey: type: apiKey in: header name: x-api-key basicAuth: type: http scheme: basic scimApiKey: type: apiKey in: header name: Authorization description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints. x-refined-from: - postman-api-openapi.yml - postman-specs-api-openapi.yml x-provenance: first_party: true method: harvested provider_published: true source: https://learning.postman.com/api-docs/openapi.json harvested: '2026-08-05' note: Postman's own OpenAPI 3.1 definition for the Postman API, served by its Fern-hosted API reference. 162 paths, 256 operations, servers api.postman.com and api.eu.postman.com.