How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Load Balancer Monitors API

The Load Balancer Monitors API from APIs.io Engineering Platform — 5 operation(s) for load balancer monitors.

APIs.io Engineering Platform Load Balancer Monitors API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Load Balancer Monitors. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

9 operations 5 paths 35 schemas 1 DELETE4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Load Balancer Monitors API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

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.

Load Balancer Monitors 9
GET
/user/load_balancers/monitors
APIs.io Engineering Platform List Monitors
load-balancer-monitors-list-monitors → 4XX200
POST
/user/load_balancers/monitors
APIs.io Engineering Platform Create Monitor
load-balancer-monitors-create-monitor body → 4XX200
DELETE
/user/load_balancers/monitors/{monitor_id}
APIs.io Engineering Platform Delete Monitor
load-balancer-monitors-delete-monitor 1 param body → 4XX200
GET
/user/load_balancers/monitors/{monitor_id}
APIs.io Engineering Platform Monitor Details
load-balancer-monitors-monitor-details 1 param → 4XX200
PATCH
/user/load_balancers/monitors/{monitor_id}
APIs.io Engineering Platform Patch Monitor
load-balancer-monitors-patch-monitor 1 param body → 4XX200
PUT
/user/load_balancers/monitors/{monitor_id}
APIs.io Engineering Platform Update Monitor
load-balancer-monitors-update-monitor 1 param body → 4XX200
POST
/user/load_balancers/monitors/{monitor_id}/preview
APIs.io Engineering Platform Preview Monitor
load-balancer-monitors-preview-monitor 1 param body → 4XX200
GET
/user/load_balancers/monitors/{monitor_id}/references
APIs.io Engineering Platform List Monitor References
load-balancer-monitors-list-monitor-references 1 param → 4XX200
GET
/user/load_balancers/preview/{preview_id}
APIs.io Engineering Platform Preview Result
load-balancer-monitors-preview-result 1 param → 4XX200

Schemas 35

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_result_info (4 properties), load-balancing_origin_health_data (4 properties), load-balancing_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

load-balancing_result_info
object
4 properties
load-balancing_timestamp
string
load-balancing_monitor
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-common-failure
object
4 properties 4 required
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_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_identifier
string
load-balancing_messages
array
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_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_timeout
integer
The timeout (in seconds) before marking the health check as failed.
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_response
load-balancing_api-response-collection
object
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_preview_result
object
Resulting health data from a preview operation.
load-balancing_description
string
Object description.
load-balancing_preview_id
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_consecutive_up
integer
To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
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_id_response
load-balancing_monitor-response-single
load-balancing_preview_result_response
load-balancing_monitor-response-collection
load-balancing_origin_health_data
object
The origin ipv4/ipv6 address or domain name mapped to it's health data.
4 properties
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_monitor-editable
object
16 properties
load-balancing_api-response-single
object
load-balancing_references_response
load-balancing_api-response-common
object
3 properties 4 required
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_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.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-load-balancer-monitors-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Load Balancer Monitors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.