APIs.io Engineering Platform Mocks API

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/).

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

OpenAPI Specification

engineering-platform-mocks-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: "1.0.0"
  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
    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

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