APIs.io Engineering Platform Collection Access Keys API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Collection Access Keys API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: Collection Access Keys
  description: 'The **Collection Access Keys** endpoints enable you to manage your [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). Collection access keys enable you to securely grant other users read-only access to a collection.


    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.

    '
paths:
  /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:
      - Collection Access Keys
      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:
      - Collection Access Keys
      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'
components:
  responses:
    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
    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
    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
    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: ''
    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
    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
  schemas:
    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
                - 'null'
                format: date-time
                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: ''
    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
    cursor:
      type: string
      example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
  parameters:
    collectionAccessKeyId:
      name: keyId
      in: path
      required: true
      description: The collection access key's ID.
      schema:
        type: string
        example: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0
    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
    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'
  securitySchemes:
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.