{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collections API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "APIs.io Engineering Platform Add a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/collections",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "The API's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 Post"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/collections/:collectionId",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "The API's ID."
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              },
              {
                "name": "versionId",
                "value": "",
                "type": "query",
                "description": "The API's version ID."
              }
            ]
          },
          "docs": "Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version.\n\n**Note:**\n\n- 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.\n- You can get a collection published in an API version with the `versionId` query parameter.\n- The `versionId` query parameter is a required param"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Sync collection with schema",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/collections/:collectionId/sync-with-schema-tasks",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "The API's ID."
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              }
            ]
          },
          "docs": "Syncs a collection attached to an API with the API schema.\n\nThis 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.\n\n**Note:**\n\nThis endpoint only supports the OpenAPI 3 schema type.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get collection access keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collection-access-keys",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "query",
                "description": "Filter the results by a collection's unique ID."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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).\n\n**Note:**\n\n- 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.\n- If the collectio"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Delete a collection access key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://apigateway.{region}.amazonaws.com/collection-access-keys/:keyId",
            "params": [
              {
                "name": "keyId",
                "value": "",
                "type": "path",
                "description": "The collection access key's ID."
              }
            ]
          },
          "docs": "Deletes a collection access key. To get a collection access key's ID, use the GET `/collection-access-key` endpoint.\n\nOn success, this returns an HTTP `204 No Content` response.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get all collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections",
            "params": [
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "The workspace's ID."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter results by collections that match the given name."
              }
            ]
          },
          "docs": "Gets all of your [collections](https://www.getpostman.com/docs/collections). The response includes all of your subscribed collections."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Create a collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collections",
            "params": [
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "The workspace's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Create a fork",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collections/fork/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              },
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "The workspace ID in which to create the fork."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Merge a fork",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collections/merge",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              },
              {
                "name": "access_key",
                "value": "",
                "type": "query",
                "description": "A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint."
              },
              {
                "name": "model",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Replace a collection's data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\n\n> The maximum collection size this endpoint accepts cannot exceed 20 MB.\n\nFor a complete list of available property values for this endpoint, use the following references available in the [Postman C"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update part of a collection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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):\n- For `variables`, refer to the **Variable List** entry.\n- For `auth`, refer to the **Auth** entry.\n- For `events`, refer to the **Event List** entry.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Delete a collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ]
          },
          "docs": "Deletes a collection."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get all forked collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/collection-forks",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of rows to return in the response."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "Sort the results by creation date in ascending (`asc`) or descending (`desc`) order."
              }
            ]
          },
          "docs": "Gets a list of all the authenticated user's forked collections."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection's comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              }
            ]
          },
          "docs": "Gets all comments left by users in a collection."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Create a collection comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a comment on a collection.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update a collection's comment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments/:commentId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "The comment's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a comment on a collection.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Delete a collection's comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments/:commentId",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "The comment's ID."
              }
            ]
          },
          "docs": "Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection's forks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/forks",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of rows to return in the response."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "Sort the results by creation date in ascending (`asc`) or descending (`desc`) order."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Pull source changes",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/pulls",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ]
          },
          "docs": "Pulls the changes from a parent (source) collection into the forked collection. In the endpoint's response:\n\n- The `destinationId` is the ID of the forked collection.\n- The `sourceId` is the ID of the source collection.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection's pull requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/pull-requests",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Create a pull request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/pull-requests",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's unique ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a pull request for a forked collection into its parent collection."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get a collection's roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/roles",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Update a collection's roles",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/roles",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\n- 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.\n- This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get source collection's status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/source-status",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              }
            ]
          },
          "docs": "Checks whether there is a change between the forked collection and its parent (source) collection.\n\nIf the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the forked collection and its source collection.\n\n**Note:**\n\nThis endpoint may take a few minutes to return an updated `isSourceAhead` status.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Transform collection to OpenAPI",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/transformations",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "The collection's ID."
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "Return the OpenAPI definition in the given format."
              }
            ]
          },
          "docs": "Transforms an existing Postman Collection into a stringified OpenAPI definition.\n\n**Note:**\n\nThis does not create an API.\n"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Transfer folders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collection-folders-transfers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copies or moves folders into a collection or folder."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Transfer requests",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collection-requests-transfers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copies or moves requests into a collection or folder."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Transfer responses",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/collection-responses-transfers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copies or moves responses into a request."
        }
      ]
    }
  ],
  "bundled": true
}