This API exposes
9 operations
across 5 paths,
and defines 35 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
9 operations5 paths35 schemas1 DELETE4 GET1 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Load Balancer Monitors API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are load-balancing_monitor-editable (16 properties), load-balancing_origin_health_data (4 properties), load-balancing_result_info (4 properties), load-balancing_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.
load-balancing_id_response
load-balancing_retries
integer
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
load-balancing_timeout
integer
The timeout (in seconds) before marking the health check as failed.
load-balancing_interval
integer
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.
load-balancing_timestamp
string
load-balancing_type
string
The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.
load-balancing_path
string
The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
load-balancing_preview_id
load-balancing_description
string
Object description.
load-balancing_preview_result_response
load-balancing_consecutive_down
integer
To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
load-balancing_expected_body
string
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 val…
load-balancing_api-response-common
object
3 properties4 required
load-balancing_allow_insecure
boolean
Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
load-balancing_references_response
load-balancing_monitor-response-collection
load-balancing_preview_response
load-balancing_expected_codes
string
The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
load-balancing_result_info
object
4 properties
load-balancing_messages
array
load-balancing_header
object
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 para…
load-balancing_port
integer
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-…
load-balancing_follow_redirects
boolean
Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
load-balancing_api-response-collection
object
load-balancing_method
string
The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connectionestablished' for TCP based health checks.
load-balancing_monitor-response-single
load-balancing_preview_result
object
Resulting health data from a preview operation.
load-balancing_identifier
string
load-balancing_monitor
load-balancing_monitor-editable
object
16 properties
load-balancing_probe_zone
string
Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
load-balancing_origin_health_data
object
The origin ipv4/ipv6 address or domain name mapped to it's health data.
4 properties
load-balancing_api-response-single
object
load-balancing_consecutive_up
integer
To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
load-balancing_api-response-common-failure
object
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
