openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collections API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Collections description: The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/). paths: /apis/{apiId}/collections: parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' post: summary: APIs.io Engineering Platform Add a collection description: "Adds a collection to an API. To do this, use the following `operationType` values:\n\n- `COPY_COLLECTION` — Copies a collection from the workspace and adds it to an API.\n- `CREATE_NEW` — Creates a new collection by providing the new collection's content.\n- `GENERATE_FROM_SCHEMA` — Generates the collection from an API schema.\n - `options` — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in 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.\n" operationId: addApiCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/addApiCollection' responses: '200': $ref: '#/components/responses/addApiCollection' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401ErrorUnauthorized' '403': description: Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/apiSchema403ErrorForbidden' - $ref: '#/components/schemas/featureUnavailable403Error' examples: Forbidden: $ref: '#/components/examples/apiSchema403ErrorForbidden' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' '404': $ref: '#/components/responses/api404ErrorNotFound' '500': $ref: '#/components/responses/common500Error' /apis/{apiId}/collections/{collectionId}: parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' - $ref: '#/components/parameters/v10Accept' get: summary: APIs.io Engineering Platform Get a collection description: 'Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version. **Note:** - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers. - You can get a collection published in an API version with the `versionId` query parameter. - The `versionId` query parameter is a required parameter for API viewers. ' operationId: getApiCollection tags: - Collections responses: '200': $ref: '#/components/responses/getApiCollection' '400': description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/api400ErrorVersionIdMissing' - $ref: '#/components/schemas/v10HeaderMissing' examples: Version ID Missing: $ref: '#/components/examples/api400ErrorVersionIdMissing' Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' '401': $ref: '#/components/responses/api401ErrorUnauthorized' '403': $ref: '#/components/responses/api403ErrorAndFeatureUnavailable' '404': $ref: '#/components/responses/apiCollection404ErrorNotFound' '422': $ref: '#/components/responses/gitLinkedApi422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiVersionQuery' /apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks: parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' - $ref: '#/components/parameters/v10Accept' put: summary: APIs.io Engineering Platform Sync collection with schema description: 'Syncs a collection attached to an API with the API schema. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the `Location` header. **Note:** This endpoint only supports the OpenAPI 3 schema type. ' operationId: syncCollectionWithSchema tags: - Collections responses: '202': $ref: '#/components/responses/syncCollectionWithSchema' '400': description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/apiCollection400InvalidParam' - $ref: '#/components/schemas/v10HeaderMissing' examples: Invalid Parameter: $ref: '#/components/examples/apiCollection400InvalidParam' Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' '401': $ref: '#/components/responses/api401ErrorUnauthorized' '403': description: Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/apiSchema403ErrorForbidden' - $ref: '#/components/schemas/featureUnavailable403Error' examples: Forbidden: $ref: '#/components/examples/apiSchema403ErrorForbidden' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' '404': $ref: '#/components/responses/apiSchema404ErrorNotFound' '422': $ref: '#/components/responses/apiSchema422ErrorActionNotAllowed' '500': $ref: '#/components/responses/common500Error' /collection-access-keys: get: summary: APIs.io Engineering Platform Get collection access keys description: 'Gets the authenticated user''s personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). **Note:** - The `expiresAfter` property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string. ' operationId: getCollectionAccessKeys tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionAccessKeys' '400': $ref: '#/components/responses/common400ErrorInvalidCursor' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403ErrorForbidden' '500': $ref: '#/components/responses/common500ErrorSomethingWrong' parameters: - $ref: '#/components/parameters/collectionUidQuery' - $ref: '#/components/parameters/cursor' /collection-access-keys/{keyId}: delete: summary: APIs.io Engineering Platform Delete a collection access key description: 'Deletes a collection access key. To get a collection access key''s ID, use the GET `/collection-access-key` endpoint. On success, this returns an HTTP `204 No Content` response. ' operationId: deleteCollectionAccessKey tags: - Collections responses: '204': description: No Content '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403ErrorForbidden' '404': $ref: '#/components/responses/cakNotFound404Error' '500': $ref: '#/components/responses/common500ErrorSomethingWrong' parameters: - $ref: '#/components/parameters/collectionAccessKeyId' /collections: get: summary: APIs.io Engineering Platform Get all collections description: Gets all of your [collections](https://www.getpostman.com/docs/collections). The response includes all of your subscribed collections. operationId: getCollections tags: - Collections responses: '200': $ref: '#/components/responses/getCollections' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500ErrorServerError' parameters: - $ref: '#/components/parameters/workspaceQuery' - $ref: '#/components/parameters/collectionNameQuery' post: summary: APIs.io Engineering Platform Create a collection description: "Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- If you do not include the `workspace` query parameter, the system creates the collection in your \"My Workspace\" workspace.\n- For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):\n - `info` object — Refer to the **Information** entry.\n - `item` object — Refer to the **Items** entry.\n- For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n" operationId: createCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/createCollection' responses: '200': $ref: '#/components/responses/createCollection' '400': $ref: '#/components/responses/collection400ErrorInstanceFound' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500ErrorServerError' parameters: - $ref: '#/components/parameters/workspaceQuery' /collections/fork/{collectionId}: parameters: - $ref: '#/components/parameters/collectionId' post: summary: APIs.io Engineering Platform Create a fork description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace. operationId: createCollectionFork tags: - Collections requestBody: $ref: '#/components/requestBodies/createCollectionFork' responses: '200': $ref: '#/components/responses/createCollectionFork' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500ErrorServerError' parameters: - $ref: '#/components/parameters/forkWorkspaceQuery' /collections/merge: post: summary: APIs.io Engineering Platform Merge a fork description: Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork. operationId: mergeCollectionFork tags: - Collections requestBody: $ref: '#/components/requestBodies/mergeCollectionFork' responses: '200': $ref: '#/components/responses/mergeCollectionFork' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403ErrorForbiddenError' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500ErrorServerError' /collections/{collectionId}: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Get a collection description: Gets information about a collection. For a complete list of this endpoint's possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). operationId: getCollection tags: - Collections responses: '200': $ref: '#/components/responses/getCollection' '400': $ref: '#/components/responses/collection400ErrorCollectionNotFound' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500ErrorServerError' parameters: - $ref: '#/components/parameters/collectionAccessKeyQuery' - $ref: '#/components/parameters/collectionModelQuery' put: summary: APIs.io Engineering Platform Replace a collection's data description: 'Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection''s ID values in the request body. If you do not, the endpoint removes the existing items and creates new items. > The maximum collection size this endpoint accepts cannot exceed 20 MB. For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html): - `info` object — Refer to the **Information** entry. - `item` object — Refer to the **Items** entry. For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** To copy another collection''s contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id` values. ' operationId: putCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/putCollection' responses: '200': $ref: '#/components/responses/putCollection' '400': $ref: '#/components/responses/collection400ErrorMalformedRequest' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500ErrorServerError' patch: summary: APIs.io Engineering Platform Update part of a collection description: 'Updates specific collection information, such as its name, events, or its variables. For more information about the `auth`, `variables`, and `events` properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html): - For `variables`, refer to the **Variable List** entry. - For `auth`, refer to the **Auth** entry. - For `events`, refer to the **Event List** entry. ' operationId: patchCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/patchCollection' responses: '200': $ref: '#/components/responses/patchCollection' '400': $ref: '#/components/responses/collection400ErrorInvalidKeyParam' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500ErrorServerError' delete: summary: APIs.io Engineering Platform Delete a collection description: Deletes a collection. operationId: deleteCollection tags: - Collections responses: '200': $ref: '#/components/responses/deleteCollection' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500ErrorServerError' /collections/{collectionId}/collection-forks: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Get all forked collections description: Gets a list of all the authenticated user's forked collections. operationId: getCollectionsForkedByUser tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionsForkedByUser' '400': $ref: '#/components/responses/fork400ErrorNoUserFound' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/createdAtSort' /collections/{collectionId}/comments: parameters: - $ref: '#/components/parameters/collectionUid' get: summary: APIs.io Engineering Platform Get a collection's comments description: Gets all comments left by users in a collection. operationId: getCollectionComments tags: - Collections responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: summary: APIs.io Engineering Platform Create a collection comment description: 'Creates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters. ' tags: - Collections operationId: createCollectionComment requestBody: $ref: '#/components/requestBodies/commentCreateUpdate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' /collections/{collectionId}/comments/{commentId}: parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/commentId' put: summary: APIs.io Engineering Platform Update a collection's comment description: 'Updates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters. ' operationId: updateCollectionComment tags: - Collections requestBody: $ref: '#/components/requestBodies/commentCreateUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: summary: APIs.io Engineering Platform Delete a collection's comment description: 'Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread. ' operationId: deleteCollectionComment tags: - Collections responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' /collections/{collectionId}/forks: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Get a collection's forks description: Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date. operationId: getCollectionForks tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionForks' '400': $ref: '#/components/responses/forkCollection400ErrorNoForks' '404': $ref: '#/components/responses/fork404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/createdAtSort' /collections/{collectionId}/pulls: parameters: - $ref: '#/components/parameters/collectionId' put: summary: APIs.io Engineering Platform Pull source changes description: 'Pulls the changes from a parent (source) collection into the forked collection. In the endpoint''s response: - The `destinationId` is the ID of the forked collection. - The `sourceId` is the ID of the source collection. ' operationId: pullCollectionChanges tags: - Collections responses: '200': $ref: '#/components/responses/pullCollectionChanges' '400': $ref: '#/components/responses/forkCollection400ErrorBadId' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500Error' /collections/{collectionId}/pull-requests: parameters: - $ref: '#/components/parameters/collectionUid' get: summary: APIs.io Engineering Platform Get a collection's pull requests description: Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests. operationId: getCollectionPullRequests tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionPullRequests' '403': $ref: '#/components/responses/pullRequest403ErrorRolePermissionsCollection' '500': $ref: '#/components/responses/common500ErrorServerError' post: summary: APIs.io Engineering Platform Create a pull request description: Creates a pull request for a forked collection into its parent collection. operationId: createCollectionPullRequest tags: - Collections requestBody: $ref: '#/components/requestBodies/pullRequestCreate' responses: '200': $ref: '#/components/responses/pullRequestCreated' '400': description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/forkCollection400ErrorBadForkRelation' - $ref: '#/components/schemas/pullRequest400ErrorDuplicate' examples: Invalid Fork Source: $ref: '#/components/examples/forkCollection400ErrorBadForkRelation' Pull Request Already Exists: $ref: '#/components/examples/pullRequest400ErrorDuplicate' '403': $ref: '#/components/responses/pullRequest403ErrorNoViewerAccessCollections' '500': $ref: '#/components/responses/common500ErrorServerError' /collections/{collectionId}/roles: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Get a collection's roles description: Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection. operationId: getCollectionRoles tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionRoles' '401': $ref: '#/components/responses/unauthorizedError' '403': $ref: '#/components/responses/common403ErrorPermissions' '404': $ref: '#/components/responses/collection404ErrorInstanceNotFound' '500': $ref: '#/components/responses/common500ErrorInternalServer' patch: summary: APIs.io Engineering Platform Update a collection's roles description: 'Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response. **Note:** - Only users assigned the EDITOR [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint. - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). ' operationId: updateCollectionRoles tags: - Collections requestBody: $ref: '#/components/requestBodies/updateCollectionRoles' responses: '204': description: No Content '400': $ref: '#/components/responses/collectionRoles400ErrorMissingProperty' '401': $ref: '#/components/responses/unauthorizedError' '403': $ref: '#/components/responses/common403ErrorPermissions' '404': $ref: '#/components/responses/collection404ErrorInstanceNotFound' '500': $ref: '#/components/responses/common500ErrorInternalServer' /collections/{collectionId}/source-status: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Get source collection's status description: 'Checks whether there is a change between the forked collection and its parent (source) collection. If the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the forked collection and its source collection. **Note:** This endpoint may take a few minutes to return an updated `isSourceAhead` status. ' operationId: getSourceCollectionStatus tags: - Collections responses: '200': $ref: '#/components/responses/getSourceCollectionStatus' '400': $ref: '#/components/responses/forkCollection400ErrorNotForked' '500': $ref: '#/components/responses/common500Error' /collections/{collectionId}/transformations: parameters: - $ref: '#/components/parameters/collectionId' get: summary: APIs.io Engineering Platform Transform collection to OpenAPI description: 'Transforms an existing Postman Collection into a stringified OpenAPI definition. **Note:** This does not create an API. ' operationId: transformCollectionToOpenAPI tags: - Collections responses: '200': $ref: '#/components/responses/transformCollectionToOpenAPI' '401': $ref: '#/components/responses/collectionToApi401Error' '404': $ref: '#/components/responses/collectionToApi404Error' '500': $ref: '#/components/responses/collectionToApi500Error' parameters: - $ref: '#/components/parameters/collectionTransformFormat' /collection-folders-transfers: post: summary: APIs.io Engineering Platform Transfer folders description: Copies or moves folders into a collection or folder. operationId: transferCollectionFolders tags: - Collections requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItems200Error' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' /collection-requests-transfers: post: summary: APIs.io Engineering Platform Transfer requests description: Copies or moves requests into a collection or folder. operationId: transferCollectionRequests tags: - Collections requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItems200Error' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' /collection-responses-transfers: post: summary: APIs.io Engineering Platform Transfer responses description: Copies or moves responses into a request. operationId: transferCollectionResponses tags: - Collections requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItems200Error' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' components: requestBodies: mergeCollectionFork: content: application/json: schema: required: - source - destination type: object properties: destination: type: string format: uid description: The destination (parent) collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 source: type: string format: uid description: The source collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 strategy: type: string description: 'The fork''s merge strategy: - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You must have Editor access to both the parent and forked collections. - `updateSourceWithDestination` — Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork. ' enum: - deleteSource - updateSourceWithDestination default: updateSourceWithDestination example: deleteSource example: strategy: deleteSource source: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 destination: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a updateCollectionRoles: content: application/json: schema: type: object required: - roles properties: roles: type: array items: type: object required: - op - path - value properties: op: type: string description: The operation to perform on the path. enum: - update example: update path: type: string description: The resource to perform the action on. enum: - /user - /group - /team example: /user value: type: array items: type: object description: Information about the updated role. required: - id - role properties: id: type: number description: The user, group, or team's ID. example: 12345678 role: type: string description: 'The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly.' enum: - VIEWER - EDITOR example: VIEWER example: roles: - op: update path: /user value: - id: 12345678 role: EDITOR - id: 87654321 role: VIEWER - op: update path: /team value: - id: 123 role: VIEWER - id: 543 role: VIEWER - op: update path: /group value: - id: 12345 role: EDITOR - id: 123 role: EDITOR pullRequestCreate: content: application/json: schema: type: object required: - title - description - reviewers - destinationId description: Information about the pull request. properties: title: type: string description: The title of the pull request. example: Test PR description: type: string description: The pull request's description. example: This is a test pull request. reviewers: type: array description: A list of reviewers to assign to the pull request. items: type: string description: The reviewer's user ID. example: '87654321' destinationId: type: string description: The collection ID to merge the pull request into. example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 example: title: Test PR description: This is a test pull request. reviewers: - '87654321' - '56781234' destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 transferCollectionItems: content: application/json: schema: $ref: '#/components/schemas/transferCollectionItems' example: ids: - 12345678-bcb5648b-eecb-4468-ade7-4efb38431bd1 target: model: collection id: 12345678-2ba6b9c4-5327-4c46-9bf3-4ec84b74b720 location: position: end model: null id: null mode: copy patchCollection: content: application/json: schema: type: object properties: collection: type: object properties: info: type: object description: An object that contains the collection's updated name and description. properties: name: type: string description: The collection's updated name. example: Test Collection v2 description: type: string description: The collection's updated description. example: This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client. variables: type: object additionalProperties: true description: The collection's updated variables. Refer to the **Variable List** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). auth: type: object additionalProperties: true description: The collection's updated authentication. Refer to the **Auth** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). events: type: object additionalProperties: true description: The collection's updated events. Refer to the **Event List** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). example: collection: info: name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. putCollection: content: application/json: schema: type: object properties: collection: type: object description: For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). required: - info - item properties: info: type: object additionalProperties: true required: - name - schema description: An object that contains basic information about the collection. For a complete list of values, refer to the **Information** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: name: type: string description: The collection's name. example: Test Collection schema: type: string format: url description: A URL to the collection's schema. example: https://schema.getpostman.com/json/collection/v2.1.0/collection.json description: type: string description: The collection's description. example: This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client. item: type: array description: 'Information about the collection''s contents, such as folders, requests, and responses. For a complete list of values, refer to the **Items** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). The maximum collection size cannot exceed 20 MB. ' items: type: object additionalProperties: true properties: name: type: string description: The collection item's name. example: Test F id: type: string description: The collection item's ID. example: ff460862-473c-41b8-8be4-a493041c3351 uid: type: string format: uid description: The collection item's unique ID. example: 12345678-ff460862-473c-41b8-8be4-a493041c3351 example: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a test. schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-09T18:34:58.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 item: - name: Test F id: ff460862-473c-41b8-8be4-a493041c3351 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] uid: 12345678-ff460862-473c-41b8-8be4-a493041c3351 commentCreateUpdate: required: true content: application/json: schema: $ref: '#/components/schemas/commentCreateUpdate' examples: Create Comment: value: body: This is an example. Tag User in Comment: value: body: This is an example. @alex-cruz tags: '@alex-cruz': type: user id: 12345678 createCollectionFork: content: application/json: schema: type: object required: - label properties: label: type: string description: The fork's label. example: Test Fork example: label: Test Fork createCollection: content: application/json: schema: type: object properties: collection: type: object description: For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). required: - info properties: info: type: object required: - name - schema description: An object that contains basic information about the collection. For a complete list of values, refer to the **Information** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: name: type: string description: The collection's name. example: Test Collection schema: type: string format: url description: A URL to the collection's schema. example: https://schema.getpostman.com/json/collection/v2.1.0/collection.json item: type: array description: Information about the collection's HTTP requests and responses. For a complete list of values, refer to the **Items** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). items: required: - request type: object properties: request: type: object description: The collection's request information. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). If you pass an empty object for this value, the system defaults to an untitled GET request. example: collection: info: name: Test Collection description: This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client. schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json item: - name: Test GET Response event: - listen: test script: id: 7d2334fc-a84a-4c3d-b26c-7529afa4c0ae exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript request: url: https://echo.getpostman.com/headers method: GET header: - key: Content-Type value: application/json addApiCollection: content: application/json: schema: anyOf: - type: object title: Copy Collection properties: data: type: object properties: collectionId: type: string description: The collection ID to copy to the API. example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 operationType: type: string description: The `COPY_COLLECTION` method. enum: - COPY_COLLECTION example: COPY_COLLECTION - type: object title: Generate from Schema properties: name: type: string description: The collection's name. example: Sample collection operationType: type: string description: The `GENERATE_FROM_SCHEMA` method. enum: - GENERATE_FROM_SCHEMA example: GENERATE_FROM_SCHEMA options: type: object additionalProperties: true description: The advanced creation options for collections and their values. For a complete list of properties and their values, 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. - type: object title: Create Collection properties: data: type: object description: Information about the collection's contents, such as requests and responses. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: info: type: object description: Information about the collection. properties: name: type: string description: The collection's name. example: Sample collection schema: type: string format: url description: The collection's schema format. enum: - https://schema.getpostman.com/json/collection/v2.1.0/collection.json example: https://schema.getpostman.com/json/collection/v2.1.0/collection.json item: type: array description: Information about the requests and responses in the collection. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). items: {} operationType: type: string description: The `CREATE_NEW` method. enum: - CREATE_NEW example: CREATE_NEW examples: Copy a Collection: value: operationType: COPY_COLLECTION data: collectionId: 12ece9e1-2abf-4edc-8e34-de66e74114d2 Generate a Collection from Schema: value: name: Test Collection operationType: GENERATE_FROM_SCHEMA options: enableOptionalParameters: true folderStrategy: Tags Add a New Collection: value: operationType: CREATE_NEW data: item: - protocolProfileBehavior: disableBodyPruning: true response: - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 200 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: The spacecraft corresponding to the provided `spacecraftId` _postman_previewtype: html body: "{\n \"id\": \"\",\n \"name\": \"commodo\",\n \"type\": \"capsule\",\n \"description\": \"pariatur dolo\"\n}" cookie: [] status: OK id: 54467f6e-71d7-43d5-acc0-48f948e38528 - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 404 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: No spacecraft found for the provided `spacecraftId` _postman_previewtype: html body: "{\n \"message\": \"dolore Excepteur\"\n}" cookie: [] status: Not Found id: 1231609a-7a3d-444d-aa0c-579703e618f4 - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 500 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: Unexpected error _postman_previewtype: html body: "{\n \"message\": \"dolore Excepteur\"\n}" cookie: [] status: Internal Server Error id: db674465-8cec-4208-9724-42278ca9b83c id: d3779255-5293-4e58-9b65-8954936e1dca request: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - key: Accept value: application/json name: Read a spacecraft auth: apikey: - type: string key: key value: X-Api-Key - type: string key: value value: SCBKCDKCHKDHCK - type: string key: in value: header type: apikey info: description: Buy or rent spacecrafts _postman_id: e726de58-f1b3-4edd-a8a7-2579dc799d39 schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json name: Generated variable: - value: / type: string id: 526a20ba-acfb-4549-a841-8edf2d24b929 key: baseUrl responses: collection400ErrorCollectionNotFound: description: Collection Not Found content: application/problem+json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: instanceNotFoundError message: type: string description: The error message. example: We could not find the collection you are looking for example: error: name: instanceNotFoundError message: We could not find the collection you are looking for forkCollection400ErrorNoForks: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: This collection id has no forks. example: collection: name: badRequest message: This collection id has no forks. getCollectionRoles: description: Successful Response content: application/json: schema: type: object description: Information about the collection's roles. properties: group: type: array description: A list of the collection's group roles. items: type: object description: Information about the group role. properties: role: type: string description: 'The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. ' enum: - VIEWER - EDITOR example: VIEWER id: type: number description: The role's ID. example: 123 team: type: array description: A list of the collection's team roles. items: type: object description: Information about the team role. properties: role: type: string description: 'The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. ' enum: - VIEWER - EDITOR example: EDITOR id: type: number description: The role's ID. example: 1 user: type: array description: A list of the collection's user roles. items: type: object description: Information about the user role. properties: role: type: string description: 'The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. ' enum: - VIEWER - EDITOR example: VIEWER id: type: number description: The role's ID. example: 12345678 example: group: - role: VIEWER id: 123 team: - role: EDITOR id: 1 user: - role: VIEWER id: 12345678 - role: EDITOR id: 87654321 collection400ErrorMalformedRequest: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: malformedRequestError message: type: string description: The error message. example: Found 2 errors with the supplied collection. details: type: array description: Information about the error. items: type: string example: ': must have required property ''item''' example: error: name: malformedRequestError message: Found 2 errors with the supplied collection. details: - ': must have required property ''item''' - 'info: must have required property ''schema''' transformCollectionToOpenAPI: description: Successful Response content: application/json: schema: type: object properties: output: type: string description: The collection's transformed output, in a stringified OpenAPI format. example: "{\n \"openapi\": \"3.0.3\",\n \"info\": {\n \"title\": \"Collection to API\",\n \"version\": \"1.0.0\",\n \"contact\": {}\n },\n \"servers\": [\n {\n \"url\": \"http://api.getpostman.com/\"\n }\n ],\n \"paths\": {},\n \"tags\": []\n}\n" example: output: "{\n \"openapi\": \"3.0.3\",\n \"info\": {\n \"title\": \"Collection to API\",\n \"version\": \"1.0.0\",\n \"contact\": {}\n },\n \"servers\": [\n {\n \"url\": \"http://api.getpostman.com/\"\n }\n ],\n \"paths\": {},\n \"tags\": []\n}\n" getSourceCollectionStatus: description: Successful Response content: application/json: schema: type: object properties: collection: type: object properties: collectionUid: type: object description: Information about the forked collection. The object's name is the forked collection's UID (`userId`-`collectionId`). properties: isSourceAhead: type: boolean description: If true, there is a difference between the forked collection and its source collection. example: false example: collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2: isSourceAhead: false collectionToApi500Error: description: Internal Server Error content: application/problem+json: schema: 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. example: https://api.postman.com/problems/internal-server-error title: type: string description: A short summary of the problem. example: Internal Server Error detail: type: string description: Information about the error. example: Internal Server Error status: type: integer format: http-status-code description: The error's HTTP status code. example: 500 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /collections/{collectionId}/apis example: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 instance: /collections/{collectionId}/apis getCollectionAccessKeys: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionAccessKeys' example: data: - id: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 token: PMAT-**********************43BR status: ACTIVE teamId: 123 userId: 12345678 collectionId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 expiresAfter: '2024-06-11T13:21:11.000Z' lastUsedAt: '' createdAt: '2024-04-12T13:21:11.000Z' updatedAt: '2024-04-09T11:00:53.000Z' - id: K7yJPzQ18BC7Snm09PXL12RMmnq57hQorFJW8JnCKhQ11JmNQiTlgXnQ1p93jGYN token: PMAT-**********************51FZ status: ACTIVE teamId: 123 userId: 56781234 collectionId: 56781234-68e5e7ac-c134-45f4-9770-40e72f3fc474 expiresAfter: '2024-06-11T13:21:11.000Z' lastUsedAt: '2024-04-29T08:24:23.000Z' createdAt: '2024-04-22T10:11:00.000Z' updatedAt: '2024-04-22T10:11:00.000Z' meta: nextCursor: b2Zmc2V0PTEwJmxpbWl0PTEw prevCursor: '' pullCollectionChanges: description: Successful Response content: application/json: schema: type: object properties: collection: type: object description: Information about the updated collection fork. properties: destinationId: type: string format: uid description: The ID of the forked collection the changes were pulled into. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 sourceId: type: string format: uid description: The ID of the source collection the changes were pulled from. example: 12345678-45499451-e894-41b8-8c66-8191ab64932a example: collection: destinationId: 112345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 sourceId: 12345678-45499451-e894-41b8-8c66-8191ab64932a common400ErrorInvalidCursor: description: Bad Request content: application/problem+json: schema: 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. example: https://api.postman.com/problems/bad-request title: type: string description: A short summary of the problem. example: Malformed request detail: type: string description: Information about the error. example: Invalid cursor status: type: integer format: http-status-code description: The error's HTTP status code. example: 400 example: type: https://api.postman.com/problems/bad-request title: Malformed request detail: Invalid cursor status: 400 deleteCollection: description: Successful Response content: application/json: schema: type: object properties: collection: type: object description: Information about the deleted collection. properties: id: type: string description: The deleted collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: type: string format: uid description: The deleted collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 example: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 common403ErrorForbidden: description: Forbidden content: application/problem+json: schema: 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. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: Forbidden status: type: number format: http-status-code description: The error's HTTP status code. example: 403 detail: type: string description: Information about the error. example: Forbidden example: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Forbidden status: 403 api403ErrorAndFeatureUnavailable: description: Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/api403ErrorForbidden' - $ref: '#/components/schemas/featureUnavailable403Error' examples: Forbidden: $ref: '#/components/examples/api403ErrorForbidden' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' collection400ErrorInvalidKeyParam: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: 'Invalid parameters: (''property'') for key: ''collection.variables''' example: error: name: badRequest message: 'Invalid parameters: (''property'') for key: ''collection.variables''' apiSchema422ErrorActionNotAllowed: description: Unprocessable Entity (WebDAV) (RFC 4918) content: application/problem+json: schema: type: object properties: type: type: string description: The error type. example: actionNotAllowedError title: type: string description: A short summary of the problem. example: Action not allowed detail: type: string description: Information about the error. example: This action is not allowed for git linked APIs example: type: actionNotAllowedError title: Action not allowed detail: This action is not allowed for git linked APIs apiSchema404ErrorNotFound: description: Schema Not Found content: application/problem+json: schema: $ref: '#/components/schemas/apiSchema404ErrorNotFound' examples: Schema Not Found: $ref: '#/components/examples/apiSchema404ErrorNotFound' unauthorizedError: description: Unauthorized content: application/problem+json: schema: 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. example: https://api.postman.com/problems/unauthorized title: type: string description: A short summary of the problem. example: Unauthorized detail: type: string description: Information about the error. example: An API key must be provided in the request header or query string status: type: number format: http-status-code description: The error's HTTP status code. example: 401 example: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: An API key must be provided in the request header or query string status: 401 fork404Error: description: Not Found content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: notFoundError message: type: string description: The error message. example: Fork not found. example: collection: name: notFoundError message: Fork not found. common403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/common403Error' example: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Forbidden status: 403 common500ErrorSomethingWrong: description: Internal Server Error content: application/problem+json: schema: 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. example: https://api.postman.com/problems/internal-server-error title: type: string description: A short summary of the problem. example: Something went wrong detail: type: string description: An explanation about the problem. example: Something went wrong status: type: integer format: http-status-code description: The HTTP status code generated by the origin server. example: 500 example: type: https://api.postman.com/problems/internal-server-error title: Something went wrong detail: Something went wrong status: 500 common500Error: description: Internal Server Error content: application/problem+json: schema: 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. example: https://api.postman.com/problems/internal-server-error title: type: string description: A short summary of the problem. example: Internal Server Error detail: type: string description: Information about the error. example: Internal Server Error example: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error common403ErrorForbiddenError: description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: forbiddenError message: type: string description: The error message. example: You do not have enough permissions to perform this action. example: error: name: forbiddenError message: You do not have enough permissions to perform this action. pullRequestCreated: description: Successful Response content: application/json: schema: type: object properties: createdAt: type: string description: The date and time at which the pull request was created. example: '2024-02-20T09:55:46.000Z' createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' description: type: string description: The pull request's description. example: This is a test pull request. destinationId: type: string description: The pull request's merge destination ID. example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: type: string description: The pull request's source (parent) ID. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: type: string description: The pull request's current status. example: open title: type: string description: The pull request's title. example: Test PR updatedAt: type: string description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:57.000Z' example: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 title: Test PR status: open sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef createdAt: '2024-02-20T09:55:46.000Z' createdBy: '12345678' updatedAt: '2024-02-20T09:58:57.000Z' description: This is a test pull request. destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 comment401Error: description: Unauthorized content: application/problem+json: schema: 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. example: https://api.postman.com/problems/unauthorized title: type: string description: A short summary of the problem. example: Unauthorized detail: type: string description: Information about the error. example: Unauthorized status: type: integer format: http-status-code description: The error's HTTP status code. example: 401 example: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 transferCollectionItems200Error: description: Successful Response content: application/json: schema: type: object properties: ids: type: array description: A list of the transferred collection request, response, or folder UIDs. items: type: string format: uid example: 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 example: ids: - 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 syncCollectionWithSchema: description: Accepted content: application/json: schema: type: object properties: taskId: type: string example: 66ae9950-0869-4e65-96b0-1e0e47e771af description: The created task ID. You can use this ID to track the status of syncing an API collection with an API schema. example: taskId: 66ae9950-0869-4e65-96b0-1e0e47e771af headers: Location: $ref: '#/components/headers/Location' common500ErrorServerError: description: Internal Server Error content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: serverError message: type: string description: The error message. example: An error has occurred on the server. example: error: name: serverError message: An error has occurred on the server. transferCollectionItems400Error: description: Bad Request content: application/problem+json: schema: 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. example: https://api.postman.com/problems/bad-request title: type: string description: A short summary of the problem. example: Cannot transfer response to target model type folder detail: type: object description: Information about the error. additionalProperties: true example: type: https://api.postman.com/problems/bad-request title: Cannot transfer response to target model type folder detail: {} api404ErrorNotFound: description: API Not Found content: application/problem+json: schema: $ref: '#/components/schemas/api404ErrorNotFound' examples: API Not Found: $ref: '#/components/examples/api404ErrorNotFound' createCollection: description: Successful Response content: application/json: schema: type: object properties: collection: type: object properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 example: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 apiCollection404ErrorNotFound: description: API Collection Not Found content: application/problem+json: schema: $ref: '#/components/schemas/apiCollection404ErrorNotFound' examples: API Collection Not Found: $ref: '#/components/examples/apiCollection404ErrorNotFound' pullRequest403ErrorRolePermissionsCollection: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/pullRequest403ErrorRolePermissionsCollection' example: detail: You need Viewer role on both source and destination collections to view pull requests. Please contact collection editors to grant additional access to you. status: 403 title: Forbidden type: https://api.postman.com/problems/forbidden fork400ErrorNoUserFound: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: No Postman User found for given filters example: collection: name: badRequest message: No Postman User found for given filters forkCollection400ErrorBadId: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: The collection Id is not a forked collection. example: collection: name: badRequest message: The collection Id is not a forked collection. commentGet: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/commentResponse' example: data: - id: 46818 threadId: 12345 createdBy: 12345678 createdAt: '2024-01-18T12:00:54.000Z' updatedAt: '2024-01-18T12:00:54.000Z' body: This is also an example. - id: 46817 threadId: 67890 createdBy: 87654321 createdAt: '2024-01-18T11:48:01.000Z' updatedAt: '2024-01-18T11:48:01.000Z' body: Another example. - id: 46814 threadId: 23456 createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an example. collectionToApi404Error: description: Not Found content: application/problem+json: schema: 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. example: https://api.postman.com/problems/not-found title: type: string description: A short summary of the problem. example: Not Found detail: type: string description: Information about the error. example: Not Found status: type: integer format: http-status-code description: The error's HTTP status code. example: 404 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /collections/{collectionId}/apis example: type: https://api.postman.com/problems/not-found title: Not Found detail: Not Found status: 404 instance: /collections/{collectionId}/apis getCollectionsForkedByUser: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: A list of the user's forked collections. items: type: object description: Information about the forked collection. properties: forkName: type: string description: The forked collection's label. example: Collection Fork forkId: type: string format: uid description: The forked collection's ID. example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: type: string description: The ID of the forked collection's source collection. example: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: type: string format: date-time description: The date and time at which the fork was created. example: '2023-11-16T09:18:17.000Z' meta: type: object description: The response's meta information for paginated results. properties: total: type: number description: The total number of forked collections. example: 2 nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== inaccessibleFork: type: number description: The total number of forked collections that the user cannot access. example: 0 example: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:18:17.000Z' - forkName: Test Fork forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null inaccessibleFork: 0 v10HeaderMissing: description: Missing v10 Accept Header content: application/problem+json: schema: $ref: '#/components/schemas/v10HeaderMissing' examples: Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' getCollectionPullRequests: description: Successful Response content: application/json: schema: type: object properties: data: type: array items: type: object description: Information about the pull request. properties: createdAt: type: string description: The date and time at which the pull request was created. example: '2024-02-20T09:55:46.000Z' createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' description: type: string description: The pull request's description. example: This is an open pull request. destinationId: type: string description: The pull request's merge destination ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 href: type: string description: A URL where you can view the pull request's details. example: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: type: string description: The pull request's source (parent) ID. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: type: string description: The pull request's current status. enum: - open - approved - declined - merged example: open comment: type: string description: If the pull request is declined, a comment about why the pull request was declined. example: Missing information. title: type: string description: The pull request's title. example: Open PR updatedBy: type: string description: The ID of the user who updated the pull request. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:38.000Z' example: data: - createdAt: '2024-02-20T09:55:46.000Z' createdBy: '12345678' description: This is an open pull request. destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 href: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: open title: Open PR updatedBy: '12345678' updatedAt: '2024-02-20T09:58:38.000Z' - createdAt: '2024-02-20T09:58:57.000Z' createdBy: '12345678' description: This is an approved PR. destinationId: 12345678-24f57217-1169-4b7c-a810-0e957c04eaa5 href: /pull-requests/ac959187-568f-4e5e-9d17-584eb44fbed2 id: ac959187-568f-4e5e-9d17-584eb44fbed2 sourceId: 87654321-e50a18a3-0dcd-49cb-afa5-d3a82cdf6134 status: approved title: Approved PR updatedBy: '12345678' updatedAt: '2024-02-20T09:58:57.000Z' - comment: Missing information. createdAt: '2024-02-20T09:55:46.000Z' createdBy: '12345678' description: This is a declined PR. destinationId: 12345678-c7f30bd9-5cc7-4569-a5fe-92270af33c6c href: /pull-requests/eda21e1f-8688-43aa-8660-35337dbac04b id: eda21e1f-8688-43aa-8660-35337dbac04b sourceId: 87654321-4beee503-1a7a-4925-a165-16fc29eaad22 status: declined title: Declined PR updatedBy: '12345678' updatedAt: '2024-02-20T09:58:38.000Z' createCollectionFork: description: Successful Response content: application/json: schema: type: object properties: collection: type: object description: Information about the forked collection. properties: id: type: string description: The forked collection's ID. example: 09547fef-a9a5-4e00-998b-aa563e8db69a name: type: string description: The collection's name. example: Test Collection fork: type: object description: Information about the collection's fork. properties: label: type: string description: The fork's label. example: Test Fork createdAt: type: string format: date-time description: The fork's creation date and time. example: '2022-06-16T19:51:44.069Z' from: type: string format: uid description: The unique ID of fork's source collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: type: string format: uid description: The forked collection's unique ID. example: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a example: collection: id: 09547fef-a9a5-4e00-998b-aa563e8db69a name: Test Collection fork: label: Test Fork createdAt: '2022-06-16T19:51:44.069Z' from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a common500ErrorInternalServer: description: Internal Server Error content: application/problem+json: schema: 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. example: https://api.postman.com/problems/internal-server-error title: type: string description: A short summary of the problem. example: Internal Sever Error detail: type: string description: An explanation about the problem. example: Internal Sever Error status: type: integer format: http-status-code description: The HTTP status code generated by the origin server. example: 500 example: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 gitLinkedApi422Error: description: Git-Linked API Errror content: application/problem+json: schema: type: object properties: type: type: string description: The error type. example: actionNotAllowedError title: type: string description: A short summary of the problem. example: Action not allowed detail: type: string description: Details about the error. example: This action is not allowed for Git linked APIs example: type: actionNotAllowedError title: Action not allowed detail: This action is not allowed for Git linked APIs getCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollection' examples: Successful Response: $ref: '#/components/examples/getCollection' Forked Collection Response: $ref: '#/components/examples/getCollectionForked' getCollectionForks: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: A list of the collection's forks. items: type: object description: Information about the forked collection. properties: createdAt: type: string format: date-time description: The date and time at which the fork was created. example: '2023-11-16T09:18:17.000Z' createdBy: type: string description: The user who created the collection fork. example: Taylor Lee forkId: type: string format: uid description: The forked collection's ID. example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f forkName: type: string description: The forked collection's label. example: Collection Fork meta: type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== total: type: number description: The total number of forked collections. example: 2 example: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f createdBy: Taylor Lee createdAt: '2023-11-16T09:18:17.000Z' - forkName: Test Fork forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null pullRequest403ErrorNoViewerAccessCollections: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/pullRequest403ErrorNoViewerAccessCollections' example: detail: You and all reviewers need Viewer access on both source and destination collections. status: 403 title: Forbidden type: https://api.postman.com/problems/forbidden putCollection: description: Successful Response content: application/json: schema: type: object properties: collection: type: object properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 example: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 instanceNotFoundCollection: description: Instance Not Found content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: instanceNotFoundError message: type: string description: The error message. example: The specified item does not exist. details: type: object description: Information about the error. properties: item: type: string description: The instance item. example: collection id: type: string description: The collection ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 example: error: name: instanceNotFoundError message: The specified item does not exist. details: item: collection id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 commentCreated: description: Created content: application/json: schema: $ref: '#/components/schemas/commentCreatedUpdated' example: data: id: 46814 createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an example. comment403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/comment403Error' example: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Forbidden status: 403 commentUpdated: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/commentCreatedUpdated' example: data: id: 46814 threadId: 12345 createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an updated example. addApiCollection: description: Created content: application/json: schema: type: object properties: id: type: string description: The collection's ID. example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 example: id: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 getCollections: description: Successful Response content: application/json: schema: type: object properties: collections: type: array items: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection owner: type: string description: The owner of the collection. example: '12345678' createdAt: type: string format: date-time description: The collection's creation date and time. example: '2022-01-13T10:21:46.000Z' updatedAt: type: string format: date-time description: The date and time at which the collection was last updated. example: '2022-01-13T10:21:46.000Z' uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 fork: type: object description: If the collection is [forked](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities), the fork's information. properties: label: type: string description: The fork's label. example: Test Fork createdAt: type: string format: date-time description: The fork's creation date and time. example: '2022-06-16T19:51:44.069Z' from: type: string description: The unique ID of the fork's source collection. example: 12345678-f2f0cb8f-609d-443f-913c-9831187c326e isPublic: type: boolean description: If true, the collection is public and visible to all users. example: false example: collections: - id: dac5eac9-148d-a32e-b76b-3edee9da28f7 name: Cloud API owner: '12345678' createdAt: '2022-04-12T10:29:46.000Z' updatedAt: '2022-04-12T10:29:56.000Z' uid: 12345678-dac5eac9-148d-a32e-b76b-3edee9da28f7 isPublic: true - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection owner: '12345678' createdAt: '2022-01-13T10:21:46.000Z' updatedAt: '2022-02-12T11:29:56.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 isPublic: false fork: label: Test Fork createdAt: '2022-06-16T19:51:44.069Z' from: 12345678-f2f0cb8f-609d-443f-913c-9831187c326e - id: f695cab7-6878-eb55-7943-ad88e1ccfd65 name: Postman Echo owner: '12345678' createdAt: '2021-04-11T09:18:26.000Z' updatedAt: '2022-05-01T15:29:32.000Z' uid: 12345678-f695cab7-6878-eb55-7943-ad88e1ccfd65 isPublic: true api401ErrorUnauthorized: description: Unauthorized content: application/problem+json: schema: 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. example: https://api.postman.com/problems/unauthorized title: type: string description: A short summary of the problem. example: Unauthorized detail: type: string description: Information about the error. example: An API key must be provided in the request header or query string status: type: number format: http-status-code description: The error's HTTP status code. example: 401 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D example: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: An API key must be provided in the request header or query string status: 401 instance: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D comment500Error: description: Internal Server Error content: application/problem+json: schema: 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. example: https://api.postman.com/problems/internal-server-error title: type: string description: A short summary of the problem. example: Internal Server Error detail: type: string description: Information about the error. example: Internal Server Error status: type: integer format: http-status-code description: The error's HTTP status code. example: 500 example: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 common403ErrorPermissions: description: Forbidden content: application/problem+json: schema: 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. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: Resource cannot be accessed detail: type: string description: Information about the error. example: Inadequate permissions. Resource access forbidden. status: type: number format: http-status-code description: The error's HTTP status code. example: 403 example: type: https://api.postman.com/problems/forbidden title: Resource cannot be accessed detail: Inadequate permissions. Resource access forbidden. status: 403 patchCollection: description: Successful Response content: application/json: schema: type: object properties: collection: type: object properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's updated name. example: Test Collection v2 description: type: string description: The collection's updated description. example: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. example: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. forkCollection400ErrorNotForked: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: The collection is not a forked collection. example: collection: name: badRequest message: The collection is not a forked collection. collection404ErrorInstanceNotFound: description: Instance Not Found content: application/json: schema: type: object properties: error: type: object properties: title: type: string description: A short summary of the problem. example: We could not find the collection you are looking for type: type: string description: The type of error. example: instanceNotFoundError example: title: We could not find the collection you are looking for type: instanceNotFoundError collectionToApi401Error: description: Unauthorized content: application/problem+json: schema: 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. example: https://api.postman.com/problems/unauthorized title: type: string description: A short summary of the problem. example: Unauthorized detail: type: string description: Information about the error. example: Unauthorized status: type: integer format: http-status-code description: The error's HTTP status code. example: 401 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /collections/{collectionId}/apis example: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 instance: /collections/{collectionId}/apis cakNotFound404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/cakNotFound404Error' example: type: https://api.postman.com/problems/not-found title: Not Found status: 404 detail: The key was not found collectionRoles400ErrorMissingProperty: description: Bad Request content: application/problem+json: schema: type: object properties: error: 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. example: https://api.postman.com/problems/bad-request title: type: string description: A short summary of the problem. example: 'Missing properties: ''path''' detail: type: string description: Information about the error. example: 'PATCH request body for ''/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/roles/roles'' failed to validate schema. Location: /properties/roles/items/required' status: type: number format: http-status-code description: The error's HTTP status code. example: 400 example: type: https://api.postman.com/problems/bad-request title: 'Missing properties: ''path''' detail: 'PATCH request body for ''/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/roles/roles'' failed to validate schema. Location: /properties/roles/items/required' status: 400 collection400ErrorInstanceFound: description: Bad Request content: application/json: schema: type: object properties: error: type: object properties: name: type: string description: The error name. example: malformedRequestError message: type: string description: The error message. example: Found 1 errors with the supplied collection. details: type: object description: Information about the error. properties: item: type: string description: The element type. example: collection id: type: string description: The element's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 example: error: name: instanceFoundError message: The specified item already exists. details: item: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 getApiCollection: description: Successful Response content: application/json: schema: type: object additionalProperties: true properties: info: type: object additionalProperties: true description: Information about the collection. properties: name: type: string description: The collection's name. example: Test Collection schema: type: string description: The collection's JSON schema version. enum: - https://schema.getpostman.com/json/collection/v2.1.0/collection.json example: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: type: string format: date-time description: The date and time at which the collection was last updated. example: '2023-06-16T20:21:13.000Z' _postman_id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: type: string description: The collection's description. example: This is a test collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. item: type: array items: type: object additionalProperties: true description: Information about the collection's contents. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: id: type: string description: The collection item's ID. example: 82ee981b-e19f-962a-401e-ea34ebfb4848 name: type: string description: The collection item's human-readable identifier. example: Test GET Response event: type: array description: The collection's event information. For a complete list of values, refer to the **Event List** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). items: type: object request: type: object additionalProperties: true description: The collection's request information. For a complete list of values, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). response: type: array description: The collection's response information. For a complete list of values, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). items: type: object example: item: - protocolProfileBehavior: disableBodyPruning: true response: - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 200 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: The spacecraft corresponding to the provided `spacecraftId` _postman_previewtype: html body: "{\n \"id\": \"\",\n \"name\": \"commodo\",\n \"type\": \"capsule\",\n \"description\": \"pariatur dolo\"\n}" cookie: [] status: OK id: 54467f6e-71d7-43d5-acc0-48f948e38528 - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 404 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: No spacecraft found for the provided `spacecraftId` _postman_previewtype: html body: "{\n \"message\": \"dolore Excepteur\"\n}" cookie: [] status: Not Found id: 1231609a-7a3d-444d-aa0c-579703e618f4 - originalRequest: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 500 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: Unexpected error _postman_previewtype: html body: "{\n \"message\": \"dolore Excepteur\"\n}" cookie: [] status: Internal Server Error id: db674465-8cec-4208-9724-42278ca9b83c id: d3779255-5293-4e58-9b65-8954936e1dca request: url: host: - https://api.getpostman.com raw: https://api.getpostman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - key: Accept value: application/json name: Read a spacecraft auth: apikey: - type: string key: key value: X-Api-Key - type: string key: value value: SCBKCDKCHKDHCK - type: string key: in value: header type: apikey info: description: Buy or rent spacecrafts _postman_id: e726de58-f1b3-4edd-a8a7-2579dc799d39 schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json name: Generated variable: - value: / type: string id: 526a20ba-acfb-4549-a841-8edf2d24b929 key: baseUrl common401Error: description: Unauthorized content: application/problem+json: schema: 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. example: https://api.postman.com/problems/unauthorized title: type: string description: A short summary of the problem. example: Unauthorized detail: type: string description: Information about the error. example: Unauthorized status: type: integer format: http-status-code description: The error's HTTP status code. example: 401 example: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 comment404Error: description: Not Found content: application/problem+json: schema: 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. example: https://api.postman.com/problems/not-found title: type: string description: A short summary of the problem. example: Not Found detail: type: string description: Information about the error. example: Not Found status: type: integer format: http-status-code description: The error's HTTP status code. example: 404 example: type: https://api.postman.com/problems/not-found title: Not Found detail: Not Found status: 404 mergeCollectionFork: description: Successful Response content: application/json: schema: type: object properties: collection: type: object properties: id: type: string description: The source collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: type: string format: uid description: The source collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 example: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 parameters: collectionModelQuery: name: model in: query description: Return a list of only the collection's root-level request (`rootLevelRequests`) and folder (`rootLevelFolders`) IDs instead of the full collection element data. schema: type: string enum: - minimal example: minimal collectionIdApi: name: collectionId in: path required: true description: The collection's unique ID. schema: type: string format: uid example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 cursor: 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. schema: $ref: '#/components/schemas/cursor' collectionUid: name: collectionId in: path required: true description: The collection's unique ID. schema: type: string format: uid example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceQuery: name: workspace in: query description: The workspace's ID. schema: $ref: '#/components/schemas/workspaceId' forkWorkspaceQuery: name: workspace in: query required: true description: The workspace ID in which to create the fork. schema: $ref: '#/components/schemas/workspaceId' commentId: name: commentId in: path required: true description: The comment's ID. schema: type: integer example: 46814 limit: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limit' createdAtSort: name: direction in: query description: Sort the results by creation date in ascending (`asc`) or descending (`desc`) order. schema: $ref: '#/components/schemas/ascDesc' collectionTransformFormat: name: format in: query description: Return the OpenAPI definition in the given format. schema: type: string default: json enum: - json - yaml example: json collectionId: name: collectionId in: path required: true description: The collection's ID. schema: type: string example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 collectionAccessKeyId: name: keyId in: path required: true description: The collection access key's ID. schema: type: string example: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 collectionAccessKeyQuery: name: access_key in: query description: A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint. schema: type: string example: none v10Accept: name: Accept in: header required: true description: The `application/vnd.api.v10+json` request header required to use the endpoint. schema: type: string enum: - application/vnd.api.v10+json example: application/vnd.api.v10+json apiId: name: apiId in: path required: true description: The API's ID. schema: type: string example: 90ca9f5a-c4c4-11ed-afa1-0242ac120002 apiVersionQuery: name: versionId in: query description: The API's version ID. schema: $ref: '#/components/schemas/apiVersionId' collectionNameQuery: name: name in: query description: Filter results by collections that match the given name. schema: type: string example: Test Collection collectionUidQuery: name: collectionId in: query description: Filter the results by a collection's unique ID. schema: type: string format: uid example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 schemas: getCollection: title: Collection Information type: object properties: collection: type: object additionalProperties: true description: For a complete list of this endpoint's possible values, use the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: info: type: object description: An object that contains basic information about the collection. properties: _postman_id: type: string description: The collection's Postman ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection description: type: string description: The collection's description. example: This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. schema: type: string format: url description: A URL to the collection's schema. example: https://schema.getpostman.com/json/collection/v2.1.0/collection.json fork: type: object description: If the collection was forked from another collection, this object contains information about the fork. properties: label: type: string description: The fork's label. example: Collection fork createdAt: type: string format: date-time description: The date and time at which the collection was forked. example: '2024-07-17T13:12:43.000Z' from: type: string format: uid description: The source (parent) collection's unique ID. example: 87654321-c8142d52-f97d-46a7-bc77-52bb99713o1n updatedAt: type: string format: date-time description: The date and time at which the collection was last updated. example: '2023-10-13T08:14:22.000Z' uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: type: string format: date-time description: The date and time at which the collection was created. example: '2023-10-08T13:04:28.000Z' lastUpdatedBy: type: string description: The user ID of the user who last updated the collection. example: '12345678' item: type: array items: type: object additionalProperties: true description: The collection's request information. For a complete list of values, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). If you pass an empty object for this value, the system defaults to an untitled GET request. comment403Error: title: Forbidden 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. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: Forbidden detail: type: string description: Information about the error. example: Forbidden status: type: integer format: http-status-code description: The error's HTTP status code. example: 403 workspaceId: type: string example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 cursor: type: string example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= api403ErrorForbidden: title: Forbidden type: object properties: type: type: string description: The type of error. example: ForbiddenError title: type: string description: A short summary of the problem. example: You are not permitted to perform the action. detail: type: string description: Information about the error. example: Please ensure that you have required permissions getCollectionAccessKeys: title: Collection Access Keys type: object properties: data: type: array description: A list of collection access keys. items: type: object description: Information about the collection access key. properties: id: type: string description: The collection access key's ID. example: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 token: type: string description: The masked collection access key. example: PMAT-**********************43BR status: type: string description: The token's active status. enum: - ACTIVE - INACTIVE example: ACTIVE teamId: type: integer description: The team ID of the collection access key's owner. example: 123 userId: type: integer description: The user ID of the collection access key's owner. example: 12345678 collectionId: type: string format: uid description: The collection access key's associated collection ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 expiresAfter: type: string format: date-time description: The date and time at which the collection access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. example: '2024-06-11T13:21:11.000Z' lastUsedAt: type: string description: The date and time at which the collection access key was used. If the collection key is unused, this returns an empty string value. example: '' createdAt: type: string format: date-time example: '2024-04-12T13:21:11.000Z' description: The date and time at which the collection access key was created. updatedAt: type: string format: date-time description: The date and time at which the collection access key was updated. example: '2024-04-12T13:21:11.000Z' deletedAt: type: string format: date-time nullable: true description: The date and time at which the collection access key was revoked. example: '2024-04-12T13:21:11.000Z' meta: type: object description: The response's non-standard metadata information. properties: nextCursor: type: string description: The pagination cursor that points to the next record in the results set. example: b2Zmc2V0PTEwJmxpbWl0PTEw prevCursor: type: string description: The pagination cursor to previous set of response data. example: '' apiCollection404ErrorNotFound: title: API Collection Not Found type: object properties: error: type: object properties: type: type: string description: The type of error. example: instanceNotFoundError title: type: string description: A short summary of the problem. example: Collection not found detail: type: string description: Information about the error. example: The API does not contain the collection you are looking for v10HeaderMissing: title: Missing v10 Accept Header type: object properties: name: type: string description: The error name. example: instanceNotFoundError message: type: string description: The error message. example: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header. apiVersionId: type: string example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 cakNotFound404Error: title: Key Not Found 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. example: https://api.postman.com/problems/not-found title: type: string description: A short summary of the problem. example: Not Found status: type: integer format: http-status-code description: The error's HTTP status code. example: 404 detail: type: string description: Information about the error. example: The key was not found transferCollectionItems: title: Transfer Items Payload type: object required: - ids - target - location - mode properties: ids: type: array description: A list of collection request, response, or folder UIDs to transfer. items: type: string format: uid example: 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 mode: type: string description: The transfer operation to perform. enum: - copy - move example: move target: type: object description: Information about the item transfer's destination location. required: - model - id properties: id: type: string format: uid example: 12345678-b91270fa-048d-4f5f-a033-8b5523bf053f description: The UID of the destination collection, folder, or request. model: type: string description: The collection, folder, or request the items will be transferred to. For response transfers, use the `request` value. enum: - collection - folder - request example: request location: type: object description: 'The transferred items'' placement in the target destination: - For `start` or `end` — Do not include the `model` and `id` values. - For `before` or `after` — Include the `model` and `id` properties. ' required: - position properties: id: type: string nullable: true format: uid description: For `before` or `after` positions, the model's UID. example: 12345678-80812b16-ac27-45b3-b3eb-793f78530d32 model: type: string nullable: true description: 'For `before` or `after` positions, the type of item (model) that the transferred item will be positioned by. One of: `folder`, `request`, or `response.` ' example: response position: type: string default: end description: The transferred item's position within the destination object. enum: - start - end - before - after example: before apiSchema403ErrorForbidden: title: Forbidden type: object properties: type: type: string description: The type of error. example: ForbiddenError title: type: string description: A short summary of the problem. example: You are not permitted to perform the action. detail: type: string description: Information about the error. example: You do not have access to perform this operation. apiSchema404ErrorNotFound: title: Schema Not Found type: object properties: type: type: string description: The type of error. example: instanceNotFoundError title: type: string description: A short summary of the problem. example: Schema not found detail: type: string description: Information about the error. example: We could not find a schema linked to this API pullRequest403ErrorNoViewerAccessCollections: title: No Viewer Permissions type: object properties: detail: type: string description: Details about the occurrence of the error. example: You and all reviewers need Viewer access on both source and destination collections. status: type: number format: http-status-code description: The error's HTTP status code. example: 403 title: type: string description: A short summary of the error. example: Forbidden type: type: string format: uri description: The error type. example: https://api.postman.com/problems/forbidden pullRequest400ErrorDuplicate: title: Pull Request Already Exists type: object properties: detail: type: string description: Details about the occurrence of the error. example: A pull request for this source and destination already exists. status: type: number format: http-status-code description: The error's HTTP status code. example: 400 title: type: string description: A short summary of the error. example: Duplicate pull request type: type: string format: uri description: The error type. example: https://api.postman.com/problems/bad-request api404ErrorNotFound: title: API Not Found type: object properties: type: type: string description: The type of error. example: instanceNotFoundError title: type: string description: A short summary of the problem. example: We could not find the API you are looking for detail: type: string description: Information about the error. example: We could not find the API you are looking for common403Error: title: Forbidden 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. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: Forbidden detail: type: string description: Information about the error. example: Forbidden status: type: integer format: http-status-code description: The error's HTTP status code. example: 403 api400ErrorVersionIdMissing: title: Version ID Missing type: object properties: type: type: string description: The error type. example: invalidParamError title: type: string description: A short summary of the problem. example: Invalid request body detail: type: string description: Details about the error. example: Missing field 'versionId' in the request body commentCreateUpdate: title: Comment Payload Object type: object description: Information about the comment. required: - body properties: body: type: string description: The contents of the comment. example: This is an example. tags: type: object description: Information about users tagged in the `body` comment. properties: userName: type: object required: - type - id description: An object that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. properties: type: type: string description: The `user` value. enum: - user example: user id: type: integer description: The user's ID. example: 87654321 commentResponse: title: Comment Response Object type: object properties: data: type: array required: - id - threadId - createdBy - createdAt - updatedAt - body items: type: object description: Information about the comment. properties: id: type: integer description: The comment's ID. example: 46814 threadId: type: integer description: The comment's thread ID. example: 12345 createdBy: type: integer description: The user ID of the user who created the comment. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the comment was created. example: '2024-01-18T11:30:40.000Z' updatedAt: type: string format: date-time description: The date and time when the comment was last updated. example: '2024-01-18T11:30:40.000Z' body: type: string description: The contents of the comment. example: This is an example. forkCollection400ErrorBadForkRelation: title: Invalid Fork Source 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. example: https://api.postman.com/problems/bad-request title: type: string description: A short summary of the problem. example: Bad Request status: type: number format: http-status-code description: The error's HTTP status code. example: 400 detail: type: string description: Information about the error. example: Fork relation not found apiCollection400InvalidParam: title: Invalid Parameter type: object properties: type: type: string description: The type of error. example: invalidParamsError title: type: string description: A short summary of the problem. example: The specified parameter is in an invalid format detail: type: string description: Information about the error. example: Parameter, collectionId is in an invalid format. commentCreatedUpdated: title: Comment Updated/Created Object type: object properties: data: type: object properties: id: type: integer description: The comment's ID. example: 46814 threadId: type: integer description: The comment's thread ID. example: 12345 createdBy: type: integer description: The user ID of the user who created the comment. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the comment was created. example: '2024-01-18T11:30:40.000Z' updatedAt: type: string format: date-time description: The date and time when the comment was last updated. example: '2024-01-18T11:30:40.000Z' body: type: string description: The contents of the comment. example: This is an example. featureUnavailable403Error: title: Feature Unavailable 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. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: Forbidden detail: type: string description: Information about the error. example: This feature isn't available in your region. status: type: integer format: http-status-code description: The error's HTTP status code. example: 403 limit: type: integer default: 10 example: 10 pullRequest403ErrorRolePermissionsCollection: title: No Role Permissions type: object properties: detail: type: string description: Details about the occurrence of the error. example: You need Viewer role on both source and destination collections to view pull requests. Please contact collection editors to grant additional access to you. status: type: number format: http-status-code description: The error's HTTP status code. example: 403 title: type: string description: A short summary of the error. example: Forbidden type: type: string format: uri description: The error type. example: https://api.postman.com/problems/forbidden ascDesc: type: string enum: - asc - desc example: asc examples: pullRequest400ErrorDuplicate: value: detail: A pull request for this source and destination already exists. status: 400 title: Duplicate pull request type: https://api.postman.com/problems/bad-request apiCollection404ErrorNotFound: value: error: type: instanceNotFoundError title: Collection not found detail: The API does not contain the collection you are looking for apiSchema403ErrorForbidden: value: title: You are not permitted to perform the action. detail: You do not have access to perform this operation. type: ForbiddenError getCollectionForked: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. fork: label: Collection fork createdAt: '2024-07-17T13:12:43.000Z' from: 87654321-c8142d52-f97d-46a7-bc77-52bb99713o1n schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-13T08:14:22.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: '2023-10-08T13:04:28.000Z' lastUpdatedBy: '12345678' item: - name: Example GET Request id: 6d64ff6f-8a48-4442-8109-25b7b4c8dcbf protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: https://postman-echo.com/get protocol: https host: - postman-echo - com path: - get response: [] uid: 12345678-6d64ff6f-8a48-4442-8109-25b7b4c8dcbf apiCollection400InvalidParam: value: type: invalidParamsError title: The specified parameter is in an invalid format detail: Parameter, collectionId is in an invalid format. getCollection: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-13T08:14:22.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: '2023-10-08T13:04:28.000Z' lastUpdatedBy: '12345678' item: - name: Example GET Request id: 6d64ff6f-8a48-4442-8109-25b7b4c8dcbf protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: https://postman-echo.com/get protocol: https host: - postman-echo - com path: - get response: [] uid: 12345678-6d64ff6f-8a48-4442-8109-25b7b4c8dcbf v10HeaderMissing: value: name: instanceNotFoundError message: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header. featureUnavailable403Error: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: This feature isn't available in your region. status: 403 api403ErrorForbidden: value: title: You are not permitted to perform the action. detail: Please ensure that you have required permissions type: ForbiddenError apiSchema404ErrorNotFound: value: type: instanceNotFoundError title: Schema not found detail: We could not find a schema linked to this API forkCollection400ErrorBadForkRelation: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: Fork relation not found api404ErrorNotFound: value: type: instanceNotFoundError title: We could not find the API you are looking for detail: We could not find the API you are looking for. api400ErrorVersionIdMissing: value: title: Invalid request body type: invalidParamError detail: Missing field 'versionId' in the request body headers: Location: description: The URL to get or poll the status of an API version task created. schema: type: string example: /apis/6138195-0262634b-cdcb-4a03-a4b9-2b221eccfbaa/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true