Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Load Balancer Healthcheck Events API

The Load Balancer Healthcheck Events API from APIs.io Engineering Platform — 1 operation(s) for load balancer healthcheck events.

This API exposes 1 operation across 1 path, and defines 19 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.

1 operations 1 paths 19 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Load Balancer Healthcheck Events 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Load Balancer Healthcheck Events 1
GET
/user/load_balancing_analytics/events
APIs.io Engineering Platform List Healthcheck Events
load-balancer-healthcheck-events-list-healthcheck-events 7 params → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are load-balancing_origin-analytics (7 properties), load-balancing_analytics (4 properties), load-balancing_api-response-common-failure (4 properties), load-balancing_result_info (4 properties). Each schema is shown below with its type and property counts.

load-balancing_schemas-name
string
A human-identifiable name for the origin.
load-balancing_origin_healthy
boolean
If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.
load-balancing_origin-failure-reason
string
Failure reason for un-healthy origin health check.
load-balancing_origin-changed
boolean
Whether the origin has changed health status.
load-balancing_pool_name
string
The name for the pool to filter.
load-balancing_address
string
The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a h…
load-balancing_api-response-common
object
3 properties 4 required
load-balancing_result_info
object
4 properties
load-balancing_origin-analytics
object
7 properties
load-balancing_messages
array
load-balancing_components-schemas-response_collection
load-balancing_schemas-identifier
string
load-balancing_api-response-collection
object
load-balancing_until
string
End date and time of requesting data period in the ISO8601 format.
load-balancing_analytics
object
4 properties
load-balancing_schemas-enabled
boolean
Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will onl…
load-balancing_origin-healthy
boolean
Whether the origin is reported as healthy.
load-balancing_origin-ip
string
The IP address (IPv4 or IPv6) of the origin.
load-balancing_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-load-balancer-healthcheck-events-api-openapi.yml Raw ↑