APIs.io Engineering Platform Load Balancer Pools 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 Pools. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
10 operations
across 5 paths,
and defines 60 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.
The identity and technical contract details declared by the specification.
load-balancing_result_info
object
4 properties
load-balancing_timestamp
string
load-balancing_longitude
number
The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
load-balancing_latitude
number
The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
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_schemas-id_response
load-balancing_networks
array
List of networks where Load Balancer or Pool is enabled.
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_name
string
A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
load-balancing_schemas-description
string
A human-readable description of the pool.
load-balancing_origin_steering
object
Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
1 property
load-balancing_notification_email
string
This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/.…
load-balancing_messages
array
load-balancing_filter_options
objectnull
Filter options for a particular resource type (pool or origin). Use null to reset.
2 properties
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_pool
object
18 properties
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_schemas-response_collection
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_patch_pools_notification_email
string
The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetti…
load-balancing_schemas-identifier
string
load-balancing_preview_response
load-balancing_schemas-references_response
load-balancing_api-response-collection
object
load-balancing_schemas-header
object
The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
1 property
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_description
string
Object description.
load-balancing_notification_filter
objectnull
Filter pool and origin health notifications by resource type or health status. Use null to reset.
2 properties
load-balancing_origin-health
object
1 property
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_check_regions
arraynull
A list of regions from which to run health checks. Null means every Cloudflare data center.
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_health_details
load-balancing_enabled
boolean
Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause…
load-balancing_origins
array
The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
load-balancing_minimum_origins
integer
The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be m…
load-balancing_schemas-name
string
A human-identifiable name for the origin.
load-balancing_origin
object
7 properties
load-balancing_disabled_at
string
This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
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_Host
array
The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
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_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_monitor-editable
object
16 properties
load-balancing_monitor_id
string
The ID of the Monitor to use for checking the health of origins within this pool.
load-balancing_schemas-disabled_at
string
This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
load-balancing_api-response-single
object
load-balancing_schemas-single_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_virtual_network_id
string
The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
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_load_shedding
object
Configures load shedding policies and percentages for the pool.
4 properties
load-balancing_weight
number
The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs APIs.io Engineering Platform publishes across the network.
