APIs.io Engineering Platform Environments API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Environments API
  description: <fullname>Amazon API Gateway</fullname> <p>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.</p>
  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
    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: Environments
  description: The **Environments** endpoints enable you to manage your Postman [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
paths:
  /environments:
    get:
      summary: APIs.io Engineering Platform Get all environments
      description: Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
      operationId: getEnvironments
      tags:
      - Environments
      responses:
        '200':
          $ref: '#/components/responses/getEnvironments'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundEnvironment'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
    post:
      summary: APIs.io Engineering Platform Create an environment
      description: 'Creates an environment.


        **Note:**


        If you do not include the `workspace` query parameter, the system creates the collection in your "My Workspace" workspace.

        '
      operationId: createEnvironment
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/createEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/createEnvironment'
        '400':
          $ref: '#/components/responses/environments400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
  /environments/{environmentId}:
    parameters:
    - $ref: '#/components/parameters/environmentId'
    get:
      summary: APIs.io Engineering Platform Get an environment
      description: Gets information about an environment.
      operationId: getEnvironment
      tags:
      - Environments
      responses:
        '200':
          $ref: '#/components/responses/getEnvironment'
        '400':
          $ref: '#/components/responses/instanceNotFoundEnvironment'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    put:
      summary: APIs.io Engineering Platform Update an environment
      description: Updates an environment.
      operationId: updateEnvironment
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/updateEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/updateEnvironment'
        '400':
          $ref: '#/components/responses/environments400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete an environment
      description: Deletes an environment.
      operationId: deleteEnvironment
      tags:
      - Environments
      responses:
        '200':
          $ref: '#/components/responses/deleteEnvironment'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundEnvironment'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /environments/{environmentId}/forks:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Create a fork
      description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an existing environment.
      operationId: forkEnvironment
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/forkEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/forkEnvironment'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQueryTrue'
    get:
      summary: APIs.io Engineering Platform Get an environment's forks
      description: Gets all of an environment's forked environments.
      operationId: getEnvironmentForks
      tags:
      - Environments
      responses:
        '200':
          $ref: '#/components/responses/getEnvironmentForks'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/directionQuery'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/sortByCreatedAt'
  /environments/{environmentId}/merges:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Merge a fork
      description: '[Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment.

        '
      operationId: mergeEnvironmentFork
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/mergeEnvironmentFork'
      responses:
        '200':
          $ref: '#/components/responses/mergeEnvironmentFork'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /environments/{environmentId}/pulls:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Pull source changes
      description: '[Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment.

        '
      operationId: pullEnvironment
      tags:
      - Environments
      requestBody:
        $ref: '#/components/requestBodies/pullEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/pullEnvironment'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  parameters:
    environmentId:
      name: environmentId
      in: path
      required: true
      description: The environment's ID.
      schema:
        type: string
        example: 5daabc50-8451-43f6-922d-96b403b4f28e
    directionQuery:
      name: direction
      in: query
      description: Sort results in ascending (`asc`) or descending (`desc`) order.
      schema:
        $ref: '#/components/schemas/ascDesc'
    environmentUid:
      name: environmentId
      in: path
      required: true
      description: The environment's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    workspaceIdQueryTrue:
      name: workspaceId
      in: query
      required: true
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    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'
    limit:
      name: limit
      in: query
      description: The maximum number of rows to return in the response.
      schema:
        $ref: '#/components/schemas/limit'
    sortByCreatedAt:
      name: sort
      in: query
      description: Sort the results by the date and time of creation.
      schema:
        type: string
        enum:
        - createdAt
        example: createdAt
    workspaceQuery:
      name: workspace
      in: query
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
  responses:
    getEnvironments:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environments:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The environment's ID.
                      example: 5daabc50-8451-43f6-922d-96b403b4f28e
                    name:
                      type: string
                      description: The environment's name.
                      example: Test Environment
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the environment was created.
                      example: '2020-09-23T14:31:18.000Z'
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the environment was last updated.
                      example: '2020-12-04T14:13:40.000Z'
                    owner:
                      type: string
                      description: The environment owner's ID.
                      example: '12345678'
                    uid:
                      type: string
                      format: uid
                      description: The environment's unique ID.
                      example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                    isPublic:
                      type: boolean
                      description: If true, the environment is public and visible to all users.
                      example: false
          example:
            environments:
            - id: 5daabc50-8451-43f6-922d-96b403b4f28e
              name: Test Environment
              createdAt: '2020-09-23T14:31:18.000Z'
              updatedAt: '2020-12-04T14:13:40.000Z'
              owner: '12345678'
              uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
              isPublic: false
            - id: 7d786cc8-142b-4d62-b5a5-872afc37ad16
              name: Environment Scanner
              createdAt: '2020-02-04T19:34:23.000Z'
              updatedAt: '2020-08-12T13:34:06.000Z'
              owner: '12345678'
              uid: 12345678-7d786cc8-142b-4d62-b5a5-872afc37ad16
              isPublic: false
    environmentForks404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              title:
                type: string
                description: A short summary of the error.
                example: Not Found
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
              detail:
                type: string
                description: Details about the occurrence of the error.
                example: We could not find the environment you are looking for
              type:
                type: string
                format: uri
                description: The error type.
                example: https://api.postman.com/problems/notFound
          example:
            title: We could not find the environment you are looking for
            status: 404
            detail: We could not find the environment you are looking for
            type: https://api.postman.com/problems/notFound
    pullEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the merged environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The merged environment's unique ID.
                    example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
          example:
            environment:
              uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
    environmentForks400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: https://api.postman.com/problems/bad-request
              title:
                type: string
                description: The title of the error message.
                example: The environment Id is not a forked environment.
              detail:
                type: object
                description: Details about the error message.
                example: {}
          examples:
            environmentNotForked:
              value:
                type: https://api.postman.com/problems/bad-request
                title: The environment Id is not a forked environment.
                detail: {}
    deleteEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                properties:
                  id:
                    type: string
                    description: The deleted environment's ID.
                    example: 4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce
                  uid:
                    type: string
                    format: uid
                    description: The deleted environment's unique ID.
                    example: 12345678-4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce
          example:
            environment:
              id: 5daabc50-8451-43f6-922d-96b403b4f28e
              uid: 1234567-5daabc50-8451-43f6-922d-96b403b4f28e
    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
    instanceNotFoundEnvironment:
      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: We could not find the environment you are looking for
          example:
            error:
              name: instanceNotFoundError
              message: We could not find the environment you are looking for
    environments400ErrorMalformedRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    example: malformedRequestError
                  message:
                    type: string
                    example: Found 1 errors with the supplied environment.
                  details:
                    type: array
                    items:
                      type: string
                      example: ': must have required property ''environment'''
          example:
            error:
              name: malformedRequestError
              message: Found 1 errors with the supplied environment.
              details:
              - ': must have required property ''environment'''
    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
    mergeEnvironmentFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the merged environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The merged environment's ID.
                    example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
          example:
            environment:
              uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
    getEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                properties:
                  id:
                    type: string
                    description: The environment's ID.
                    example: 5daabc50-8451-43f6-922d-96b403b4f28e
                  name:
                    type: string
                    description: The environment's name.
                    example: Test Environment
                  owner:
                    type: string
                    description: The ID of environment's owner.
                    example: '12345678'
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the environment was created.
                    example: '2020-11-05T13:59:22.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the environment was last updated.
                    example: '2020-11-05T13:59:23.000Z'
                  values:
                    type: array
                    description: Information about the environment's variables.
                    items:
                      type: object
                      properties:
                        enabled:
                          type: boolean
                          description: If true, the variable is enabled.
                          example: true
                        key:
                          type: string
                          description: The variable's name.
                          example: collectionId
                        value:
                          type: string
                          description: The variable's value.
                          example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                        type:
                          type: string
                          description: The variable type.
                          enum:
                          - secret
                          - default
                          - any
                          example: default
                  isPublic:
                    type: boolean
                    description: If true, the environment is public and visible to all users.
                    example: false
          example:
            environment:
              id: 5daabc50-8451-43f6-922d-96b403b4f28e
              name: Test Environment
              owner: '12345678'
              createdAt: '2020-11-05T13:59:22.000Z'
              updatedAt: '2020-11-05T13:59:23.000Z'
              values:
              - key: collectionId
                value: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                enabled: true
                type: default
              isPublic: false
    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
    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.
    forkEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the forked environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The forked environment's ID.
                    example: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
                  name:
                    type: string
                    description: The name of the forked environment.
                    example: Testing Environment
                  forkName:
                    type: string
                    description: The forked environment's label.
                    example: Test Fork
          example:
            environment:
              uid: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
              name: Testing Environment
              forkName: Test Fork
    createEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                properties:
                  id:
                    type: string
                    description: The environment's ID.
                    example: 5daabc50-8451-43f6-922d-96b403b4f28e
                  name:
                    type: string
                    description: The environment's name.
                    example: Test Environment
                  uid:
                    type: string
                    format: uid
                    description: The environment's unique ID.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
          example:
            environment:
              id: 5daabc50-8451-43f6-922d-96b403b4f28e
              name: Test Environment
              uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
    getEnvironmentForks:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the environment's forks.
                items:
                  type: object
                  description: Information about the forked environment.
                  properties:
                    forkId:
                      type: string
                      format: uid
                      description: The forked environment's unique ID.
                      example: 12345678-2fgh78uj-2ee3-8ugc-b678-7742d82e2e1f
                    forkName:
                      type: string
                      description: The forked environment's label.
                      example: my fork
                    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 environment fork.
                      example: Taylor Lee
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was last updated.
                      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 environments.
                    example: 6
                  nextCursor:
                    type: string
                    nullable: true
                    description: The pagination cursor that points to the next record in the results set.
                    example: null
          example:
            data:
            - forkId: 12345678-2fgh78uj-2ee3-8ugc-b678-7742d82e2e1f
              forkName: my fork
              createdAt: '2023-11-16T09:18:17.000Z'
              createdBy: Taylor Lee
              updatedAt: '2023-11-16T09:18:17.000Z'
            - forkId: 12345678-667df1ad-2ee3-6yhn-b678-7742d82e2e1f
              forkName: fork2
              createdAt: '2023-11-16T09:16:15.000Z'
              createdBy: Taylor Lee
              updatedAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 6
              nextCursor: null
    updateEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                properties:
                  id:
                    type: string
                    description: The environment's ID.
                    example: 5daabc50-8451-43f6-922d-96b403b4f28e
                  name:
                    type: string
                    description: The environment's name.
                    example: Test A Environment
                  uid:
                    type: string
                    format: uid
                    description: The environment's unique ID.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
          example:
            environment:
              id: 5daabc50-8451-43f6-922d-96b403b4f28e
              name: Test A Environment
              uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
  requestBodies:
    createEnvironment:
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                re

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-environments-api-openapi.yml