openapi: 3.1.0
info:
  title: Postman API (Test Scripts) Collections API
  description: Subset of the Postman API used to manage collections, environments, monitors, and mock servers that contain Postman test scripts. The Postman API base URL is https://api.getpostman.com and authentication is performed via the X-Api-Key request header.
  version: v1
  contact:
    name: Postman API
    url: https://learning.postman.com/docs/introduction/overview/
servers:
- url: https://api.getpostman.com
security:
- apiKey: []
tags:
- name: Collections
paths:
  /collections:
    get:
      summary: List collections
      operationId: listCollections
      responses:
        '200':
          description: Collections listed.
      tags:
      - Collections
    post:
      summary: Create a collection (containing test scripts)
      operationId: createCollection
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                collection:
                  type: object
      responses:
        '200':
          description: Collection created.
      tags:
      - Collections
  /collections/{collection_uid}:
    get:
      summary: Get a collection
      operationId: getCollection
      parameters:
      - name: collection_uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Collection returned.
      tags:
      - Collections
    put:
      summary: Update a collection
      operationId: updateCollection
      parameters:
      - name: collection_uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Collection updated.
      tags:
      - Collections
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key