APIs.io Engineering Platform Load Balancer 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 Load Balancer 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: Load Balancer Monitors
paths:
  /user/load_balancers/monitors:
    get:
      description: List configured monitors for a user.
      operationId: load-balancer-monitors-list-monitors
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-collection'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitors response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-collection'
          description: List Monitors response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Monitors
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
      - 'Load Balancing: Monitors and Pools Read'
    post:
      description: Create a configured monitor.
      operationId: load-balancer-monitors-create-monitor
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Create Monitor response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Create Monitor response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Monitor
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/monitors/{monitor_id}:
    delete:
      description: Delete a configured monitor.
      operationId: load-balancer-monitors-delete-monitor
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_id_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Delete Monitor response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_id_response'
          description: Delete Monitor response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Monitor
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
    get:
      description: List a single configured monitor for a user.
      operationId: load-balancer-monitors-monitor-details
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Monitor Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Monitor Details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Monitor Details
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
      - 'Load Balancing: Monitors and Pools Read'
    patch:
      description: Apply changes to an existing monitor, overwriting the supplied properties.
      operationId: load-balancer-monitors-patch-monitor
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Monitor response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Patch Monitor response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Patch Monitor
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
    put:
      description: Modify a configured monitor.
      operationId: load-balancer-monitors-update-monitor
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Update Monitor response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Update Monitor response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Monitor
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/monitors/{monitor_id}/preview:
    post:
      description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
      operationId: load-balancer-monitors-preview-monitor
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_preview_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Monitor response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
          description: Preview Monitor response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Preview Monitor
      tags:
      - Load Balancer Monitors
  /user/load_balancers/monitors/{monitor_id}/references:
    get:
      description: Get the list of resources that reference the provided monitor.
      operationId: load-balancer-monitors-list-monitor-references
      parameters:
      - in: path
        name: monitor_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_references_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitor References response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_references_response'
          description: List Monitor References response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Monitor References
      tags:
      - Load Balancer Monitors
  /user/load_balancers/preview/{preview_id}:
    get:
      description: Get the result of a previous preview operation using the provided preview_id.
      operationId: load-balancer-monitors-preview-result
      parameters:
      - in: path
        name: preview_id
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_preview_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_preview_result_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Result response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_result_response'
          description: Preview Result response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Preview Result
      tags:
      - Load Balancer Monitors
      x-api-token-group:
      - 'Load Balancing: Monitors and Pools Read'
components:
  schemas:
    load-balancing_id_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/load-balancing_identifier'
            type: object
    load-balancing_retries:
      default: 2
      description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
      type: integer
    load-balancing_timeout:
      default: 5
      description: The timeout (in seconds) before marking the health check as failed.
      type: integer
    load-balancing_interval:
      default: 60
      description: The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
      type: integer
    load-balancing_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      readOnly: true
      type: string
    load-balancing_type:
      default: http
      description: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.
      enum:
      - http
      - https
      - tcp
      - udp_icmp
      - icmp_ping
      - smtp
      example: https
      type: string
    load-balancing_path:
      default: /
      description: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
      example: /health
      type: string
    load-balancing_preview_id:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
    load-balancing_description:
      description: Object description.
      example: Login page monitor
      type: string
    load-balancing_preview_result_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/load-balancing_preview_result'
    load-balancing_consecutive_down:
      default: 0
      description: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
      type: integer
    load-balancing_expected_body:
      description: A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
      example: alive
      type: string
    load-balancing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/load-balancing_messages'
        messages:
          $ref: '#/components/schemas/load-balancing_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    load-balancing_allow_insecure:
      default: false
      description: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
      example: true
      type: boolean
    load-balancing_references_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-collection'
      - properties:
          result:
            description: List of resources that reference a given monitor.
            example:
            - reference_type: referrer
              resource_id: 17b5962d775c646f3f9725cbc7a53df4
              resource_name: primary-dc-1
              resource_type: pool
            items:
              properties:
                reference_type:
                  enum:
                  - '*'
                  - referral
                  - referrer
                  type: string
                resource_id:
                  type: string
                resource_name:
                  type: string
                resource_type:
                  type: string
              type: object
            type: array
    load-balancing_monitor-response-collection:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/load-balancing_monitor'
            type: array
    load-balancing_preview_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            properties:
              pools:
                additionalProperties:
                  description: The pool name associated with the pool ID.
                  type: string
                description: Monitored pool IDs mapped to their respective names.
                example:
                  abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter
                  ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter
                type: object
              preview_id:
                $ref: '#/components/schemas/load-balancing_identifier'
            type: object
    load-balancing_expected_codes:
      default: '200'
      description: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
      example: 2xx
      type: string
    load-balancing_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    load-balancing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    load-balancing_header:
      additionalProperties:
        items:
          type: string
        type: array
      description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
      example:
        Host:
        - example.com
        X-App-ID:
        - abc123
      type: object
    load-balancing_port:
      default: 0
      description: 'The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).'
      type: integer
    load-balancing_follow_redirects:
      default: false
      description: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
      example: true
      type: boolean
    load-balancing_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/load-balancing_result_info'
      type: object
    load-balancing_method:
      default: GET
      description: The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
      example: GET
      type: string
    load-balancing_monitor-response-single:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/load-balancing_monitor'
    load-balancing_preview_result:
      additionalProperties:
        properties:
          healthy:
            type: boolean
          origins:
            items:
              additionalProperties:
                $ref: '#/components/schemas/load-balancing_origin_health_data'
              maxProperties: 1
              minProperties: 1
              type: object
            type: array
        type: object
      description: Resulting health data from a preview operation.
      example:
        abwlnp5jbqn45ecgxd03erbgtxtqai0d:
          healthy: true
          origins:
          - originone.example.com.:
              failure_reason: No failures
              healthy: true
              response_code: 200
              rtt: 66ms
      type: object
    load-balancing_identifier:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
      type: string
    load-balancing_monitor:
      allOf:
      - $ref: '#/components/schemas/load-balancing_monitor-editable'
      - properties:
          created_on:
            $ref: '#/components/schemas/load-balancing_timestamp'
          id:
            $ref: '#/components/schemas/load-balancing_identifier'
          modified_on:
            $ref: '#/components/schemas/load-balancing_timestamp'
        type: object
    load-balancing_monitor-editable:
      properties:
        allow_insecure:
          $ref: '#/components/schemas/load-balancing_allow_insecure'
        consecutive_down:
          $ref: '#/components/schemas/load-balancing_consecutive_down'
        consecutive_up:
          $ref: '#/components/schemas/load-balancing_consecutive_up'
        description:
          $ref: '#/components/schemas/load-balancing_description'
        expected_body:
          $ref: '#/components/schemas/load-balancing_expected_body'
        expected_codes:
          $ref: '#/components/schemas/load-balancing_expected_codes'
        follow_redirects:
          $ref: '#/components/schemas/load-balancing_follow_redirects'
        header:
          $ref: '#/components/schemas/load-balancing_header'
        interval:
          $ref: '#/components/schemas/load-balancing_interval'
        method:
          $ref: '#/components/schemas/load-balancing_method'
        path:
          $ref: '#/components/schemas/load-balancing_path'
        port:
          $ref: '#/components/schemas/load-balancing_port'
        probe_zone:
          $ref: '#/components/schemas/load-balancing_probe_zone'
        retries:
          $ref: '#/components/schemas/load-balancing_retries'
        timeout:
          $ref: '#/components/schemas/load-balancing_timeout'
        type:
          $ref: '#/components/schemas/load-balancing_type'
      type: object
    load-balancing_probe_zone:
      description: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
      example: example.com
      type: string
    load-balancing_origin_health_data:
      description: The origin ipv4/ipv6 address or domain name mapped to it's health data.
      example:
        failure_reason: No failures
        healthy: true
        response_code: 200
        rtt: 66ms
      properties:
        failure_reason:
          type: string
        healthy:
          type: boolean
        response_code:
          type: number
        rtt:
          type: string
      type: object
    load-balancing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-common'
      - properties:
          result:
            anyOf:
            - nullable: true
              type: object
            - nullable: true
              type: string
      type: object
    load-balancing_consecutive_up:
      default: 0
      description: To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
      type: integer
    load-balancing_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/load-balancing_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/load-balancing_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
  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