APIs.io Engineering Platform Monitors API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Monitors 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: Monitors
  description: The **Monitors** endpoints enable you to manage your [monitors](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/).
paths:
  /monitors:
    get:
      summary: APIs.io Engineering Platform Get all monitors
      description: Gets all monitors.
      operationId: getMonitors
      tags:
      - Monitors
      responses:
        '200':
          $ref: '#/components/responses/getMonitors'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceResultsQuery'
    post:
      summary: APIs.io Engineering Platform Create a monitor
      description: 'Creates a monitor.


        **Note:**


        You cannot create monitors for collections added to an API definition.

        '
      operationId: createMonitor
      tags:
      - Monitors
      requestBody:
        $ref: '#/components/requestBodies/createMonitor'
      responses:
        '200':
          $ref: '#/components/responses/createMonitor'
        '400':
          $ref: '#/components/responses/monitors400CreateErrors'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorAndFeatureUnavailable'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
  /monitors/{monitorId}:
    parameters:
    - $ref: '#/components/parameters/monitorId'
    get:
      summary: APIs.io Engineering Platform Get a monitor
      description: Gets information about a monitor.
      operationId: getMonitor
      tags:
      - Monitors
      responses:
        '200':
          $ref: '#/components/responses/getMonitor'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundMonitor'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    put:
      summary: APIs.io Engineering Platform Update a monitor
      description: Updates a monitor.
      operationId: updateMonitor
      tags:
      - Monitors
      requestBody:
        $ref: '#/components/requestBodies/updateMonitor'
      responses:
        '200':
          $ref: '#/components/responses/updateMonitor'
        '400':
          $ref: '#/components/responses/monitors400ErrorInvalidCronPattern'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundMonitor'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a monitor
      description: Deletes a monitor.
      operationId: deleteMonitor
      tags:
      - Monitors
      responses:
        '200':
          $ref: '#/components/responses/deleteMonitor'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /monitors/{monitorId}/run:
    parameters:
    - $ref: '#/components/parameters/monitorId'
    - $ref: '#/components/parameters/async'
    post:
      summary: APIs.io Engineering Platform Run a monitor
      description: 'Runs a monitor and returns its run results.


        **Note:**


        If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint.

        '
      operationId: runMonitor
      tags:
      - Monitors
      responses:
        '200':
          $ref: '#/components/responses/runMonitor'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
components:
  examples:
    monitors400ErrorInvalidEnvironmentUid:
      value:
        error:
          name: invalidUidError
          message: The specified uid is invalid.
          details:
            param: environment
            uid: 5daabc50-8451-43f6-922d-96b403b4f28e
    monitors400ErrorInvalidCronPattern:
      value:
        error:
          name: cronPatternNotAllowedError
          message: Invalid cron pattern. Enter a valid cron pattern, such as "0 17 * * *"
          details:
            pattern: '* * * * *'
    monitors400ErrorInvalidCollectionUid:
      value:
        error:
          name: invalidUidError
          message: The specified uid is invalid.
          details:
            param: collection
            uid: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    monitors400ErrorMissingParameter:
      value:
        error:
          name: paramMissingError
          message: Parameter is missing in the request.
          details:
            param:
            - name
    monitors400ErrorInvalidTimezone:
      value:
        error:
          name: invalidParamsError
          message: The request had invalid parameters
          details:
            param: schedule.timezone
  schemas:
    monitors400ParamMissing:
      title: Missing Parameter
      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: A list of the missing parameters.
                  items:
                    type: string
                    example: name
    monitors400ErrorInvalidUid:
      title: Invalid UID
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
              description: The error name.
              example: invalidUidError
            message:
              type: string
              description: The error message.
              example: The specified uid is invalid.
            details:
              type: object
              description: Information about the error.
              properties:
                param:
                  type: string
                  description: The invalid parameter.
                  example: collection
                uid:
                  type: string
                  format: uid
                  description: The invalid UID.
                  example: 5daabc50-8451-43f6-922d-96b403b4f28e
    workspaceId:
      type: string
      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    featureUnavailable403Error:
      title: Feature Unavailable
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/forbidden
        title:
          type: string
          description: A short summary of the problem.
          example: Forbidden
        detail:
          type: string
          description: Information about the error.
          example: This feature isn't available in your region.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    monitors400ErrorInvalidTimezone:
      title: Invalid Timezone
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
              description: The error name.
              example: invalidParamsError
            message:
              type: string
              description: The error message.
              example: The request had invalid parameters
            details:
              type: object
              description: Information about the error.
              properties:
                param:
                  type: string
                  description: The invalid parameter.
                  example: schedule.timezone
    common403Error:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/forbidden
        title:
          type: string
          description: A short summary of the problem.
          example: Forbidden
        detail:
          type: string
          description: Information about the error.
          example: Forbidden
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    monitors400ErrorInvalidCronPattern:
      title: Invalid Cron Pattern
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
              description: The error name.
              example: cronPatternNotAllowedError
            message:
              type: string
              description: The error message.
              example: Invalid cron pattern. Enter a valid cron pattern, such as "0 17 * * *"
            details:
              type: object
              description: Information about the error.
              properties:
                pattern:
                  type: string
                  description: The invalid cron pattern.
                  example: '* * * * *'
  parameters:
    monitorId:
      name: monitorId
      in: path
      required: true
      description: The monitor's ID.
      schema:
        type: string
        example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
    workspaceResultsQuery:
      name: workspace
      in: query
      description: Return only results found in the given workspace.
      schema:
        $ref: '#/components/schemas/workspaceId'
    async:
      name: async
      in: query
      description: If true, runs the monitor asynchronously from the created monitor run task. By default, the server will not respond until the task finishes (`false`).
      schema:
        type: boolean
        default: false
        example: false
    workspaceQuery:
      name: workspace
      in: query
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
  responses:
    featureUnavailable403Error:
      description: Feature Unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/featureUnavailable403Error'
          example:
            value:
              type: https://api.postman.com/problems/forbidden
              title: Forbidden
              detail: This feature isn't available in your region.
              status: 403
    getMonitor:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              monitor:
                type: object
                properties:
                  id:
                    type: string
                    description: The monitor's ID.
                    example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  name:
                    type: string
                    description: The monitor's name.
                    example: Test Monitor
                  uid:
                    type: string
                    format: uid
                    description: The monitor's unique ID.
                    example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  owner:
                    type: number
                    description: The ID of monitor's owner.
                    example: 12345678
                  collectionUid:
                    type: string
                    format: uid
                    description: The unique ID of the monitor's associated collection.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  environmentUid:
                    type: string
                    format: uid
                    description: The unique ID of the monitor's associated environment.
                    example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                  distribution:
                    type: array
                    description: A list of the monitor's [geographic regions](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#adding-regions).
                    items:
                      type: string
                    example: []
                  lastRun:
                    type: object
                    description: Information about the monitor's previous run.
                    properties:
                      finishedAt:
                        type: string
                        format: date-time
                        description: The date and time at which the monitor's previous run completed.
                        example: '2022-06-17T18:39:53.707Z'
                      startedAt:
                        type: string
                        format: date-time
                        description: The date and time at which the monitor's previous run started.
                        example: '2022-06-17T18:39:52.852Z'
                      stats:
                        type: object
                        description: Information about the monitor's stats.
                        properties:
                          assertions:
                            type: object
                            description: Information about the monitor's assertions.
                            properties:
                              failed:
                                type: number
                                description: The total number of test failures.
                                example: 1
                              total:
                                type: number
                                description: The total number of tests performed.
                                example: 8
                          requests:
                            type: object
                            description: Information about the monitor's requests.
                            properties:
                              total:
                                type: number
                                description: The total number of requests.
                                example: 4
                      status:
                        type: string
                        description: The monitor's status after its last run.
                        example: failed
                  notifications:
                    type: object
                    description: Information about the monitor's notification settings.
                    properties:
                      onError:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              format: email
                              description: The email address of the user to notify on monitor error.
                              example: taylor.lee@example.com
                      onFailure:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              format: email
                              description: The email address of the user to notify on monitor failure.
                              example: taylor.lee@example.com
                  options:
                    type: object
                    description: Information about the monitor's option settings.
                    properties:
                      followRedirects:
                        type: boolean
                        description: If true, follow redirects enabled.
                        example: true
                      requestDelay:
                        type: number
                        description: The monitor's request delay value.
                        example: 0
                      requestTimeout:
                        type: number
                        description: The monitor's request timeout value.
                        example: 3000
                      strictSSL:
                        type: boolean
                        description: If true, strict SSL enabled.
                        example: true
                  schedule:
                    type: object
                    description: Information about the monitor's schedule.
                    properties:
                      cron:
                        type: string
                        description: The monitor's cron frequency value.
                        example: 0 0 * * * *
                      nextRun:
                        type: string
                        format: date-time
                        description: The date and time of monitor's next scheduled run.
                        example: '2022-06-18T05:00:00.000Z'
                      timezone:
                        type: string
                        description: The monitor's timezone.
                        example: America/Chicago
          example:
            monitor:
              id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              name: Test Monitor
              uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              owner: 12345678
              collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
              options:
                strictSSL: true
                followRedirects: true
                requestTimeout: 3000
                requestDelay: 0
              notifications:
                onError:
                - email: taylor.lee@example.com
                onFailure:
                - email: taylor.lee@example.com
              distribution: []
              schedule:
                cron: 0 0 0 * * *
                timezone: America/Chicago
                nextRun: '2022-06-18T05:00:00.000Z'
              lastRun:
                status: failed
                startedAt: '2022-06-17T18:39:52.852Z'
                finishedAt: '2022-06-17T18:39:53.707Z'
                stats:
                  assertions:
                    total: 8
                    failed: 1
                  requests:
                    total: 4
    createMonitor:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              monitor:
                type: object
                properties:
                  id:
                    type: string
                    description: The monitor's ID.
                    example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  name:
                    type: string
                    description: The monitor's name.
                    example: Test Monitor
                  uid:
                    type: string
                    format: uid
                    description: The monitor's unique ID.
                    example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
          example:
            monitor:
              id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              name: Test Monitor
              uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
    deleteMonitor:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              monitor:
                type: object
                properties:
                  id:
                    type: string
                    description: The monitor's ID.
                    example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  uid:
                    type: string
                    format: uid
                    description: The monitor's unique ID.
                    example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
          example:
            monitor:
              id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
    updateMonitor:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              monitor:
                type: object
                properties:
                  id:
                    type: string
                    description: The monitor's ID.
                    example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                  name:
                    type: string
                    description: The monitor's name.
                    example: Test Monitor
                  uid:
                    type: string
                    format: uid
                    description: The monitor's unique ID.
                    example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
          example:
            monitor:
              id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              name: Test Monitor
              uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
    getMonitors:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              monitors:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The monitor's ID.
                      example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
                    name:
                      type: string
                      description: The monitor's name.
                      example: Test Monitor
                    owner:
                      type: string
                      description: The ID of the monitor's owner.
                      example: '12345678'
                    uid:
                      type: string
                      format: uid
                      description: The monitor's unique ID.
                      example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
          example:
            monitors:
            - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              name: Test Monitor
              uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1
              owner: '12345678'
            - id: 1e6b6cb7-f13d-4000-acb7-0695757174a8
              name: Postman Echo Monitor
              uid: 87654321-1e6b6cb7-f13d-4000-acb7-0695757174a8
              owner: '87654321'
    instanceNotFoundMonitor:
      description: Instance Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: The specified monitor does not exist.
          example:
            error:
              name: instanceNotFoundError
              message: The specified monitor does not exist.
    monitors400ErrorInvalidCronPattern:
      description: Invalid Cron Pattern
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/monitors400ErrorInvalidCronPattern'
          example:
            value:
              error:
                name: cronPatternNotAllowedError
                message: Invalid cron pattern. Enter a valid cron pattern, such as "0 17 * * *"
                details:
                  pattern: '* * * * *'
    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
    monitors400CreateErrors:
      description: Bad Request
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/monitors400ErrorInvalidCronPattern'
            - $ref: '#/components/schemas/monitors400ErrorInvalidTimezone'
            - $ref: '#/components/schemas/monitors400ErrorInvalidUid'
            - $ref: '#/components/schemas/monitors400ParamMissing'
          examples:
            Invalid Cron Pattern:
              $ref: '#/components/examples/monitors400ErrorInvalidCronPattern'
            Invalid Timezone:
              $ref: '#/components/examples/monitors400ErrorInvalidTimezone'
            Invalid Collection UID:
              $ref: '#/components/examples/monitors400ErrorInvalidCollectionUid'
            Invalid Environment UID:
              $ref: '#/components/examples/monitors400ErrorInvalidEnvironmentUid'
            Missing Parameter:
              $ref: '#/components/examples/monitors400ErrorMissingParameter'
    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.
    runMonitor:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              run:
                type: object
                description: Information about the monitor run. If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint.
                properties:
                  info:
                    type: object
                    description: Information about the monitor.
                    properties:
                      jobId:
                        type: string
                        description: The monitor's run job ID.
                        example: 1ecee76a-e14e-47c0-bddc-256bf690c407
                      collectionUid:
                        type: string
                        format: uid
                        description: The unique ID of the monitor's associated collection.
                        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                      environmentUid:
                        type: string
                        format: uid
                        description: The unique ID of the monitor's associated environment.
                        example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e
                      monitorId:
                        type: string
                        description: The monitor'

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