openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Mocks 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
      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: Mocks
  description: The **Mocks** endpoints enable you to manage your [mock servers](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/).
paths:
  /mocks:
    get:
      summary: APIs.io Engineering Platform Get all mock servers
      description: 'Gets all active mock servers. By default, this endpoint returns only mock servers you created across all workspaces.


        **Note:**


        If you pass both the `teamId` and `workspace` query parameters, this endpoint only accepts the `workspace` query.

        '
      operationId: getMocks
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/getMocks'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/teamIdResultsQuery'
      - $ref: '#/components/parameters/workspaceResultsQuery'
    post:
      summary: APIs.io Engineering Platform Create a mock server
      description: 'Creates a mock server in a collection.


        **Note:**


        - If you do not include the `workspaceId` query parameter, the system creates the mock server in your [Personal

        workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).

        - You cannot create mocks for collections added to an API definition.

        '
      operationId: createMock
      tags:
      - Mocks
      requestBody:
        $ref: '#/components/requestBodies/createMock'
      responses:
        '200':
          $ref: '#/components/responses/mockCreateUpdate'
        '400':
          $ref: '#/components/responses/paramMissing400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQuery'
  /mocks/{mockId}:
    parameters:
    - $ref: '#/components/parameters/mockId'
    get:
      summary: APIs.io Engineering Platform Get a mock server
      description: Gets information about a mock server.
      operationId: getMock
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/getMock'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    put:
      summary: APIs.io Engineering Platform Update a mock server
      description: Updates a mock server.
      operationId: updateMock
      tags:
      - Mocks
      requestBody:
        $ref: '#/components/requestBodies/updateMock'
      responses:
        '200':
          $ref: '#/components/responses/mockCreateUpdate'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a mock server
      description: Deletes a mock server.
      operationId: deleteMock
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/deleteMock'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /mocks/{mockId}/call-logs:
    parameters:
    - $ref: '#/components/parameters/mockId'
    get:
      summary: APIs.io Engineering Platform Get a mock server's call logs
      description: 'Gets a mock server''s call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit is met first in one API call.


        Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use case.


        **Note:**


        Call logs have a retention period based on your [Postman plan](https://www.postman.com/pricing/#mock-calls). For more information, see [this article](https://support.postman.com/hc/en-us/articles/21219973964951-I-can-t-see-my-mock-server-logs-history) in the [Postman Support Center](https://support.postman.com/).

        '
      operationId: getMockCallLogs
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/getMockCallLogs'
        '400':
          $ref: '#/components/responses/mock400ErrorLogRetentionPeriodExceeded'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/limitDefault100'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/mockResponseStatusCode'
      - $ref: '#/components/parameters/mockResponseType'
      - $ref: '#/components/parameters/mockRequestMethod'
      - $ref: '#/components/parameters/mockRequestPath'
      - $ref: '#/components/parameters/mockSortServedAt'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/mockInclude'
  /mocks/{mockId}/publish:
    parameters:
    - $ref: '#/components/parameters/mockId'
    post:
      summary: APIs.io Engineering Platform Publish a mock server
      description: Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.
      operationId: publishMock
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/publishMock'
        '400':
          $ref: '#/components/responses/mock400ErrorAlreadyPublished'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /mocks/{mockId}/unpublish:
    parameters:
    - $ref: '#/components/parameters/mockId'
    delete:
      summary: APIs.io Engineering Platform Unpublish a mock server
      description: Unpublishes a mock server. Unpublishing a mock server sets its **Access Control** configuration setting to private.
      operationId: unpublishMock
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/unpublishMock'
        '400':
          $ref: '#/components/responses/mock400ErrorAlreadyUnpublished'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /mocks/{mockId}/server-responses:
    parameters:
    - $ref: '#/components/parameters/mockId'
    get:
      summary: APIs.io Engineering Platform Get all server responses
      description: Gets all of a mock server's server responses.
      operationId: getMockServerResponses
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/getMockServerResponses'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    post:
      summary: APIs.io Engineering Platform Create a server response
      description: 'Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503.


        Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior on a mock server. You do not need to define each error for all exposed paths on the mock server.


        If you set a server response as active, then all the calls to the mock server return with that active server response.


        **Note:**


        You can create multiple server responses for a mock server, but only one mock server can be set as active.

        '
      operationId: createMockServerResponse
      tags:
      - Mocks
      requestBody:
        $ref: '#/components/requestBodies/createMockServerResponse'
      responses:
        '200':
          $ref: '#/components/responses/mockServerResponse'
        '400':
          $ref: '#/components/responses/paramMissing400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /mocks/{mockId}/server-responses/{serverResponseId}:
    parameters:
    - $ref: '#/components/parameters/mockId'
    - $ref: '#/components/parameters/serverResponseId'
    get:
      summary: APIs.io Engineering Platform Get a server response
      description: Gets information about a server response.
      operationId: getMockServerResponse
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/mockServerResponse'
        '400':
          $ref: '#/components/responses/serverResponseNotFound400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/mockId'
      - $ref: '#/components/parameters/serverResponseId'
    put:
      summary: APIs.io Engineering Platform Update a server response
      description: Updates a server response.
      operationId: updateMockServerResponse
      tags:
      - Mocks
      requestBody:
        $ref: '#/components/requestBodies/updateMockServerResponse'
      responses:
        '200':
          $ref: '#/components/responses/mockServerResponse'
        '400':
          $ref: '#/components/responses/paramMissing400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a server response
      description: Deletes a mock server's server response.
      operationId: deleteMockServerResponse
      tags:
      - Mocks
      responses:
        '200':
          $ref: '#/components/responses/deleteMockServerResponse'
        '400':
          $ref: '#/components/responses/serverResponseNotFound400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/mock400ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
components:
  responses:
    deleteMockServerResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the deleted server response.
            properties:
              id:
                type: string
                description: The server response's ID.
                example: 965cdd16-fe22-4d96-a161-3d05490ac421
              name:
                type: string
                description: The server response's name.
                example: Internal Server Error
              statusCode:
                type: number
                description: The server response's 5xx HTTP response code.
                example: 500
              headers:
                type: array
                description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
                items:
                  type: object
                  properties:
                    key:
                      type: string
                      description: The request header's key value.
                      example: Content-Type
                    value:
                      type: string
                      description: The request header's value.
                      example: application/json
              language:
                type: string
                nullable: true
                description: The server response's body language type.
                enum:
                - text
                - javascript
                - json
                - html
                - xml
                example: json
              body:
                type: string
                description: The server response's body that returns when calling the mock server.
                example: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
              createdBy:
                type: string
                description: The user ID of the user who created the server response.
                example: '12345678'
              updatedBy:
                type: string
                description: The user ID of the user who last updated the server response.
                example: '12345678'
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the server response was created.
                example: '2022-09-21T20:20:09.000Z'
          example:
            id: 965cdd16-fe22-4d96-a161-3d05490ac421
            name: Internal Server Error
            statusCode: 500
            headers: []
            language: json
            body: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
            createdBy: '20891195'
            updatedBy: '20891195'
            createdAt: '2022-09-21T20:20:09.000Z'
    publishMock:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                properties:
                  id:
                    type: string
                    description: The mock server's ID.
                    example: e3d951bf-873f-49ac-a658-b2dcb91d3289
          example:
            mock:
              id: e3d951bf-873f-49ac-a658-b2dcb91d3289
    mock400ErrorLogRetentionPeriodExceeded:
      description: Log Retention Period Exceeded
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: invalidParamsError
                  message:
                    type: string
                    description: The error message.
                    example: 'Invalid value for parameter: since. Cannot view logs beyond the call log retention period based on your plan i.e. 30 days.'
          example:
            error:
              name: invalidParamsError
              message: 'Invalid value for parameter: since. Cannot view logs beyond the call log retention period based on your plan i.e. 30 days.'
    getMocks:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mocks:
                type: array
                items:
                  type: object
                  description: Information about the mock servers.
                  properties:
                    id:
                      type: string
                      description: The mock server's ID.
                      example: e3d951bf-873f-49ac-a658-b2dcb91d3289
                    owner:
                      type: string
                      description: The ID of mock server's owner.
                      example: '12345678'
                    uid:
                      type: string
                      format: uid
                      description: The mock server's unique ID.
                      example: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706
                    collection:
                      type: string
                      description: The unique ID of the mock's associated collection.
                      example: 12345678-39fee52f-b806-3ffa-1173-00a6f5b183dc
                    mockUrl:
                      type: string
                      format: url
                      description: The mock server URL.
                      example: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
                    config:
                      type: object
                      description: Information about the mock server's configuration.
                      properties:
                        delay:
                          type: object
                          nullable: true
                          description: Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
                          properties:
                            type:
                              type: string
                              description: 'The type of simulated delay value:

                                - `fixed` — The delay value is a fixed value.

                                '
                              example: fixed
                              enum:
                              - fixed
                            preset:
                              type: string
                              description: 'The simulated fixed network delay value:

                                - `1` — 2G (300 ms).

                                - `2` — 3G (100 ms).

                                The object does not return this value for custom delay values.

                                '
                              example: '2'
                              enum:
                              - '1'
                              - '2'
                            duration:
                              type: integer
                              description: The configured delay, in milliseconds.
                              example: 100
                        headers:
                          type: array
                          description: A list of the mock server's headers.
                          items:
                            type: string
                          example: []
                        matchBody:
                          type: boolean
                          description: If true, match the request body.
                          example: false
                        matchQueryParams:
                          type: boolean
                          description: If true, match query parameters.
                          example: true
                        matchWildcards:
                          type: boolean
                          description: If true, use wildcard variable matching.
                          example: true
                        serverResponseId:
                          type: string
                          description: The ID of mock server's default response for requests. All calls to the mock server will return the defined response.
                          example: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the mock server was created.
                      example: '2022-06-09T19:00:39.000Z'
                    environment:
                      type: string
                      description: The mock server's associated environment ID.
                      example: 1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524
                    isPublic:
                      type: boolean
                      description: If true, the mock server is public and visible to all users. This field does not indicate the mock server's access control status.
                      example: false
                    name:
                      type: string
                      description: The mock server's name.
                      example: Test Mock
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the mock server was last updated.
                      example: '2022-06-09T19:00:39.000Z'
          example:
            mocks:
            - id: e3d951bf-873f-49ac-a658-b2dcb91d3289
              owner: '12345678'
              uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
              collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
              name: Test Mock A
              config:
                headers: []
                matchBody: false
                matchQueryParams: true
                matchWildcards: true
                delay:
                  type: fixed
                  duration: 140000
                serverResponseId: ''
              createdAt: '2022-07-25T20:54:30.000Z'
              updatedAt: '2022-07-25T20:54:30.000Z'
              isPublic: false
              environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
            - id: cf0f8f11-fe0e-455f-99f3-4177f10f0704
              owner: '12345678'
              uid: 12345678-cf0f8f11-fe0e-455f-99f3-4177f10f0704
              collection: 12345678-2cd8f6b1-e85b-46a6-8111-bd62e73e8aa8
              mockUrl: https://cf0f8f11-fe0e-455f-99f3-4177f10f0704.mock.pstmn.io
              name: Test Mock B
              config:
                headers: []
                matchBody: false
                matchHeader: false
                matchQueryParams: true
                matchWildcards: true
                delay: null
                serverResponseId: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65
              createdAt: '2023-01-26T18:59:05.000Z'
              updatedAt: '2023-01-26T18:59:05.000Z'
              isPublic: false
    mockServerResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the mock server's responses.
            additionalProperties: true
            properties:
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the server response was created.
                example: '2022-08-02T14:57:44.000Z'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the server response was last updated.
                example: '2022-08-02T14:57:44.000Z'
              id:
                type: string
                description: The server response's ID.
                example: 965cdd16-fe22-4d96-a161-3d05490ac421
              name:
                type: string
                description: The server response's name.
                example: Internal Server Error
              statusCode:
                type: number
                description: The server response's 5xx HTTP response code.
                example: 500
              headers:
                type: array
                description: The server response's request headers key-value pairs, such as Content-Type, Accept, encoding, and other information.
                items:
                  type: object
                  description: Information about the key-value pair.
                  properties:
                    key:
                      type: string
                      description: The request header's key value.
                      example: Content-Type
                    value:
                      type: string
                      description: The request header's value.
                      example: application/json
              language:
                type: string
                description: The server response's body language type.
                example: json
              body:
                type: string
                description: The server response's body that returns when calling the mock server.
                example: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
              createdBy:
                type: string
                description: The user ID of the user who created the server response.
                example: '12345678'
              updatedBy:
                type: string
                description: The user ID of the user who last updated the server response.
                example: '12345678'
              mock:
                type: string
                description: The associated mock server's ID.
                example: 32cd624d-9986-4f20-9048-89252f722269
          example:
            createdAt: '2022-08-02T15:08:03.000Z'
            updatedAt: '2022-08-02T15:08:03.000Z'
            id: 965cdd16-fe22-4d96-a161-3d05490ac421
            name: Internal Server Error
            statusCode: 500
            headers:
            - key: Content-Type
              value: application/json
            language: json
            body: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
            createdBy: '12345678'
            updatedBy: '12345678'
            mock: 32cd624d-9986-4f20-9048-89252f722269
    paramMissing400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: paramMissingError
                  message:
                    type: string
                    description: The error message.
                    example: Parameter is missing in the request.
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      param:
                        type: array
                        description: Information about the missing parameter.
                        items:
                          type: string
          examples:
            Missing name Parameter:
              value:
                error:
                  name: paramMissingError
                  message: Parameter is missing in the request.
                  details:
                    param:
                    - name
            Missing collection Parameter:
              value:
                error:
                  name: paramMissingError
                  message: Parameter is missing in the request.
                  details:
                    param:
                    - collection
            Missing Mock serverResponse parameter:
              value:
                error:
                  name: paramMissingError
                  message: Parameter is missing in the request.
                  details:
                    param:
                    - serverResponse
            Missing Server Response statusCode parameter:
              value:
                error:
                  name: paramMissingError
                  message: Parameter is missing in the request.
                  details:
                    param:
                    - statusCode
    getMock:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                properties:
                  id:
                    type: string
                    description: The mock server's ID.
                    example: e3d951bf-873f-49ac-a658-b2dcb91d3289
                  owner:
                    type: string
                    description: The ID of mock server's owner.
                    example: '12345678'
                  uid:
                    type: string
                    format: uid
                    description: The mock server's unique ID.
                    example: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706
                  collection:
                    type: string
                    description: The unique ID of the mock's associated collection.
                    example: 12345678-39fee52f-b806-3ffa-1173-00a6f5b183dc
                  mockUrl:
                    type: string
                    format: url
                    description: The mock server URL.
                    example: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
                  name:
                    type: string
                    description: The mock server's name.
                    example: Test Mock
                  config:
                    type: object
                    description: Information about the mock server's configuration.
                    properties:
                      headers:
                        type: array
                        description: A list of the mock server's headers.
                        items:
                          type: string
                      matchBody:
                        type: boolean
                        description: If true, match the request body.
                        example: false
                      matchQueryParams:
                        type: boolean
                        description: If true, match query parameters.
                        example: true
                      matchWildcards:
                        type: boolean
                        description: If true, use wildcard variable matching.
                        example: true
                      serverResponseId:
                        type: string
                        nullable: true
                        description: The ID of mock server's default response for requests. All calls to the mock server will return the defined response.
                        example: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the mock server was created.
                    example: '2022-06-09T19:00:39.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the mock server was last updated.
                    example: '2022-06-09T19:00:39.000Z'
                  isPublic:
                    type: boolean
                    description: If true, the mock server is public and visible to all users. This field does not indicate the mock server's access control status.
                    example: false
                  deactivated:
                    type: boolean
                    description: If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted.
                    example: false
                  environment:
                    type: string
                    description: The mock server's associated environment ID.
                    example: 1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524
          example:
            mock:
              id: e3d951bf-873f-49ac-a658-b2dcb91d3289
              owner: '12345678'
              uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
              collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
              name: Test Mock
              config:
                headers: []
                matchBody: false
                matchQueryParams: true
                matchWildcards: true
                delay:
                  type: fixed
                  duration: 140000
                serverResponseId: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65
              createdAt: '2022-07-25T20:54:30.000Z'
              updatedAt: '2022-07-25T20:54:30.000Z'
              isPublic: false
              deactivated: false
              environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
    unpublishMock:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                properties:
                  id:
                    type: string
                    description: The mock server's ID.
                    example: e3d951bf-873f-49ac-a658-b2dcb91d3289
          example:
            mock:
              id: e3d951bf-873f-49ac-a658-b2dcb91d3289
    mock400ErrorAlreadyPublished:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: mockAlreadyPublishedError
                  message:
                    type: string
                    description: The error message.
                    example: This mock is already public.
          example:
            error:
              name: mockAlreadyPublishedError
              message: This mock is already public.
    serverResponseNotFound400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverResponseNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the mock server response you are looking for.
          example:
            error:
              name: serverResponseNotFoundError
              message: We could not find the mock server response you are looking for.
    deleteMock:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                description: Information about the mock server.
                properties:
                  id:
                    type: string
                    description: The mock server's ID.
                    example: e3d951bf-873f-49ac-a658-b2dcb91d3289
                  uid:
                    type: string
                    format: uid
                    description: The mock server's unique ID.
                    example: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706
          example:
            mock:
              id: e782b64e-406b-4a6c-8fe9-9ebe84aeb706
              uid: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706
    getMockServerResponses:
      description: Successful Response
      content:
        application/json:
          schema:
            type: array
            description: Information about the mock server's responses.
            items:
              type: object
              description: Information about the server response.
              properties:
                id:
                  type: string
                  description: The server response's ID.
                  example: 965cdd16-fe22-4d96-a161-3d05490ac421
                name:
                  type: string
                  description: The server response's name.
                  example: Internal Server Error
                statusCode:
                  type: number
                  description: The server response's 5xx HTTP response code.
                  example: 500
                createdAt:
                  type: string
                  format: date-time
                  description: The date and time at which the server response was created.
                  example: '2022-08-02T14:57:44.000Z'
                updatedAt:
                  type: string
                  format: date-time
                  description: The date and time at which the server response was last updated.
                  example: '2022-08-02T14:57:44.000Z'
                createdBy:
                  type: string
                  description: The user ID of the user who created the server response.
                  example: '12345678'
                updatedBy:
                  type: string
                  description: The user ID of the user who last updated the server response.
                  example: '12345678'
          example:
          - id: 965cdd16-fe22-4d96-a161-3d05490ac421
            name: Internal Server Error
            statusCode: 500
            createdAt: '2022-08-02T14:57:44.000Z'
            updatedAt: '2022-08-02T14:57:44.000Z'
            createdBy: '12345678'
            updatedBy: '12345678'
    getMockCallLogs:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              call-logs:
                type: array
                items:
                  type: object
                  description: Information about the mock server's server responses.
                  properties:
                    id:
                      type: string
                      description: The server response's ID.
                      example: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925
                    responseName:
                      type: string
                      description: The server response's name.
                      example: Bad Request
                    servedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the server response was served.
                      example: '2022-01-17T06:19:22.000Z'
                    request:
                      type: object
                      description: The server response's request information.
                      properties:
                        method:
                          type: string
                          description: The request method.
                          example: POST
                        path:
                          type: string
                          description: The request's path.
                          example: /animals
                        headers:
                          type: object
                          description: The request's headers.
                          properties:
                            key:
                              type: string
                              description: The request header's name.
                              example: content-type
                            value:
                              type: string
                              description: The request header's value.
                              example: application/json
                        body:
                          type: object
                          description: The request's body information.
                          properties:
                            mode:
                              type: string
                              description: The request body's media type (mode).
                              example: raw
                            data:
                              type: string
                              description: The request body's contents.
                              example: '{"type":"hamster","breed":"Syrian Hamster","age":"1 month"}'
                    response:
                      type: object
                      description: The server response's response information.
                      properties:
                        type:
                          type: string
                          description: The type of response.
                        statusCode:
                          type: number
                          description: The response's status code.
                          example: 400
                        headers:
                          type: object
                          description: The response's headers.
                          properties:
                            description:
                              type: object
                              description: The response header's description information.
                              properties:
                                content:
                                  type: string
                                  description: The response header description's content.
                                  example: ''
                                type:
                                  type: string
                                  description: The response header description's media type.
                                  example: text/plain
                            key:
                              type: string
                              description: The response header's name.
                              example: content-type
                            value:
                              type: string
                              description: The response header's value.
                              example: application/json
                        body:
                          type: object
                          description: The response's body information.
                          properties:
                            data:
                              type: string
                              description: The response body's contents.
                              example: "{\n\t\"message\": \"Malformed request. You need to send gender as part of the request.\"\n}"
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  nextCursor:
                    type: string
                    nullable: true
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJOZXdQZXQuanNvbiJ9
          example:
            call-logs:
            - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545
              responseName: Double check your method and the request path and try again.
              servedAt: '2022-01-17T06:19:30.000Z'
              request:
                method: POST
                path: /animals
              response:
                type: error
                statusCode: 404
            - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925
              responseName: Bad request
              servedAt: '2022-01-17T06:19:22.000Z'
              request:
                method: POST
                path: /animals
              response:
                type: success
                statusCode: 400
            - id: adab0d30-5c38-43bf-af90-4119925138e2-3795
              responseName: Successful addition of animals to the store
              servedAt: '2022-01-17T06:19:16.000Z'
              request:
                method: POST
                path: /animals
              response:
                type: success
                statusCode: 200
            - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468
              responseName: Get filtered list of Animals
              servedAt: '2022-01-17T06:18:26.000Z'
              request:
                method: GET
                path: /animals?type=dog
              response:
                type: success
                statusCode: 200
            - id: a5330463-26e1-4812-a962-e44b569a2054-9894
              responseName: Get Animals
              servedAt: '2022-01-17T06:18:06.000Z'
              request:
                method: GET
                path: /animals
              response:
                type: success
                statusCode: 200
            meta:
              nextCursor: null
    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
    mock400ErrorAlreadyUnpublished:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: mockAlreadyUnpublishedError
                  message:
                    type: string
                    description: The error message.
                    example: This mock has already been deleted.
          example:
            error:
              name: mockAlreadyUnpublishedError
              message: This mock has already been deleted.
    mock400ErrorInstanceNotFound:
      description: 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 mock does not exist.
          example:
            error:
              name: instanceNotFoundError
              message: The specified mock does not exist.
    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.
    mockCreateUpdate:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                description: Information about the mock server.
                properties:
                  id:
                    type: string
                    description: The mock server's ID.
                    example: e3d951bf-873f-49ac-a658-b2dcb91d3289
                  owner:
                    type: string
                    description: The ID of mock server's owner.
                    example: '12345678'
                  uid:
                    type: string
                    format: uid
                    description: The mock server's unique ID.
                    example: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
                  collection:
                    type: string
                    description: The unique ID of the mock's associated collection.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  mockUrl:
                    type: string
                    format: url
                    description: The mock server URL.
                    example: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
                  config:
                    type: object
                    description: Information about the mock server's configuration.
                    additionalProperties: true
                    properties:
                      matchBody:
                        type: boolean
                        description: If true, the mock server matches the request's body to the body of the saved examples.
                        example: false
                      matchHeader:
                        type: boolean
                        description: If true, the mock server matches the request's headers in the `header` array to the headers of the saved examples.
                        example: true
                      headers:
                        type: array
                        description: A list of header key values.
                        items:
                          type: string
                          example: POST
                      matchQueryParams:
                        type: boolean
                        description: If true, match query parameters to the saved examples.
                        example: false
                      matchWildcards:
                        type: boolean
                        description: If true, use wildcard variable matching.
                      delay:
                        type: object
                        nullable: true
                        description: Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
                        properties:
                          type:
                            type: string
                            description: The `fixed` value.
                            enum:
                            - fixed
                            example: fixed
                          duration:
                            type: integer
                            description: For custom network delays, the custom configured delay, in milliseconds.
                            example: 700
                          preset:
                            type: string
                            description: 'The simulated fixed network delay value:

                              - `1` — 2G (300 ms).

                              - `2` — 3G (100 ms).

                              The object does not return this value for custom delay values.

                              '
                            enum:
                            - '1'
                            - '2'
                            example: '2'
                      serverResponseId:
                        type: string
                        nullable: true
                        description: The ID of mock server's default response for requests. All calls to the mock server will return the defined response.
                        example: 9a291bbe-dc0a-44ba-a3c8-6dbd06a61460
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the mock server was created.
                    example: '2022-06-09T19:00:39.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the mock server was last updated.
                    example: '2022-06-09T19:00:39.000Z'
                  environment:
                    type: string
                    description: The unique ID of the mock's associated environment.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
          example:
            mock:
              id: e3d951bf-873f-49ac-a658-b2dcb91d3289
              owner: '12345678'
              uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289
              collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io
              name: Test Mock
              config:
                headers:
                - POST
                matchBody: false
                matchQueryParams: true
                matchWildcards: true
                delay:
                  type: fixed
                  preset: '1'
                  duration: 300
                serverResponseId: 9a291bbe-dc0a-44ba-a3c8-6dbd06a61460
              createdAt: '2022-06-09T19:00:39.000Z'
              updatedAt: '2022-06-09T19:00:39.000Z'
              environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
  schemas:
    sinceDateTime:
      type: string
      format: date-time
      example: '2022-06-01T00:00:00.000Z'
    workspaceId:
      type: string
      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    ascDesc:
      type: string
      enum:
      - asc
      - desc
      example: asc
    cursor:
      type: string
      example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
    untilDateTime:
      type: string
      format: date-time
      example: '2022-06-15T00:00:00.000Z'
  parameters:
    serverResponseId:
      name: serverResponseId
      in: path
      required: true
      description: The server response's ID.
      schema:
        type: string
        example: 965cdd16-fe22-4d96-a161-3d05490ac421
    mockId:
      name: mockId
      in: path
      required: true
      description: The mock's ID.
      schema:
        type: string
        example: e3d951bf-873f-49ac-a658-b2dcb91d3289
    direction:
      name: direction
      in: query
      description: Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the `sort` parameter.
      schema:
        $ref: '#/components/schemas/ascDesc'
    mockResponseStatusCode:
      name: responseStatusCode
      in: query
      description: Return only call logs that match the given HTTP response status code.
      schema:
        type: number
        example: 500
    mockSortServedAt:
      name: sort
      in: query
      description: Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter.
      schema:
        type: string
        enum:
        - servedAt
        example: servedAt
    mockResponseType:
      name: responseType
      in: query
      description: Return only call logs that match the given response type. Matching is not case-sensitive.
      schema:
        type: string
        example: success
    since:
      name: since
      in: query
      description: Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value.
      schema:
        $ref: '#/components/schemas/sinceDateTime'
    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'
    workspaceIdQuery:
      name: workspaceId
      in: query
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    workspaceResultsQuery:
      name: workspace
      in: query
      description: Return only results found in the given workspace.
      schema:
        $ref: '#/components/schemas/workspaceId'
    teamIdResultsQuery:
      name: teamId
      in: query
      description: Return only results that belong to the given team ID.
      schema:
        type: string
        example: 1b96f65f-8d23-4e1d-b5e2-055992c3b8cbd2567dfa09a9
    mockInclude:
      name: include
      in: query
      description: Include call log records with header and body data. This query parameter accepts the `request.headers`, `request.body`, `response.headers`, and `response.body` values. For multiple include types, comma-separate each value.
      schema:
        type: string
        example: request.headers,request.body,response.headers,response.body
    mockRequestPath:
      name: requestPath
      in: query
      description: Return only call logs that match the given request path. Matching is not case-sensitive.
      schema:
        type: string
        example: /animals?type=Dog
    mockRequestMethod:
      name: requestMethod
      in: query
      description: Return only call logs that match the given HTTP method. Matching is not case-sensitive.
      schema:
        type: string
        example: post
    limitDefault100:
      name: limit
      in: query
      description: The maximum number of rows to return in the response.
      schema:
        type: number
        default: 100
        example: 3
    until:
      name: until
      in: query
      description: Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value.
      schema:
        $ref: '#/components/schemas/untilDateTime'
  requestBodies:
    createMock:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                required:
                - collection
                properties:
                  collection:
                    type: string
                    format: uid
                    description: The unique ID of the mock's associated collection.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  environment:
                    type: string
                    format: uid
                    description: The unique ID of the mock's associated environment.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                  name:
                    type: string
                    description: The mock server's name.
                    example: Test Mock
                  private:
                    type: boolean
                    default: false
                    description: If true, the mock server is set private. By default, mock servers are public and can receive requests from anyone and anywhere.
                    example: true
          example:
            mock:
              name: Test Mock
              collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
              private: true
    updateMockServerResponse:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              serverResponse:
                type: object
                properties:
                  name:
                    type: string
                    description: The server response's name.
                    example: Internal Server Error
                  statusCode:
                    type: integer
                    description: The server response's 5xx HTTP response code. This property only accepts [5xx values](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
                    example: 500
                  headers:
                    type: array
                    description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
                    items:
                      type: object
                      description: Information about the key-value pair.
                      properties:
                        key:
                          type: string
                          description: The request header's key value.
                          example: Content-Type
                        value:
                          type: string
                          description: The request header's value. This value defines the corresponding value for the header key.
                          example: application/json
                  language:
                    type: string
                    nullable: true
                    description: The server response's body language type.
                    enum:
                    - text
                    - javascript
                    - json
                    - html
                    - xml
                    example: json
                  body:
                    type: string
                    description: The server response's body that returns when you call the mock server.
                    example: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
          example:
            serverResponse:
              name: Internal Server Error
              statusCode: 500
              headers:
              - key: Content-Type
                value: application/json
              language: json
              body: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
    updateMock:
      content:
        application/json:
          schema:
            type: object
            properties:
              mock:
                type: object
                properties:
                  name:
                    type: string
                    description: The mock server's name.
                    example: Test Mock
                  environment:
                    type: string
                    format: uid
                    description: The associated environment's unique ID.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                  description:
                    type: string
                    description: The mock server's description.
                    example: This is a test mock server.
                  private:
                    type: boolean
                    default: false
                    description: If true, the mock server is set private. By default, mock servers are public and can receive requests from anyone and anywhere.
                    example: true
                  versionTag:
                    type: string
                    description: The API's version tag ID.
                    example: abf07d3d-f8ec-47d4-8015-9fe83078b4ec
                  config:
                    type: object
                    description: The mock server's configuration settings.
                    properties:
                      serverResponseId:
                        type: string
                        nullable: true
                        description: 'The server response ID. This sets the given server response as the default response for each request.


                          To deactivate a server response, pass a null value.

                          '
                        example: 9a291bbe-dc0a-44ba-a3c8-6dbd06a61460
          example:
            mock:
              name: Test Mock
              environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
              description: This is a test mock server.
              private: true
              versionTag: abf07d3d-f8ec-47d4-8015-9fe83078b4ec
    createMockServerResponse:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              serverResponse:
                type: object
                required:
                - name
                - statusCode
                properties:
                  name:
                    type: string
                    description: The server response's name.
                    example: Internal Server Error
                  statusCode:
                    type: integer
                    description: The server response's 5xx HTTP response code. This property only accepts 5xx values.
                    example: 500
                  headers:
                    type: array
                    description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: The request header's key value.
                          example: Content-Type
                        value:
                          type: string
                          description: The request header's value.
                          example: application/json
                  language:
                    type: string
                    nullable: true
                    description: The server response's body language type.
                    enum:
                    - text
                    - javascript
                    - json
                    - html
                    - xml
                    example: json
                  body:
                    type: string
                    description: The server response's body that returns when calling the mock server.
                    example: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
          example:
            serverResponse:
              name: Internal Server Error
              statusCode: 500
              header:
              - key: Content-Type
                value: application/json
              language: json
              body: "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
  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