Schemas

ACL ID.

ACL name.

ACL match filter object. One of ip_subnet, ips_edge_services or http_filter & http_filter_value are required.

Action to take when incoming traffic matches an ACL filter.

ACL is attached to this frontend object.

Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).

Date on which the ACL was created. (RFC 3339 format)

Date on which the ACL was last updated. (RFC 3339 format)

ACL description.

Action to take when incoming traffic matches an ACL filter.

Redirection parameters when using an ACL with a redirect action.

Redirect type.

Redirect target. For a location redirect, you can use a URL e.g. https://scaleway.com. Using a scheme name (e.g. https, http, ftp, git) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a location redirect to preserve parts of the original request in the redirection URL are {{host}}, {{query}}, {{path}} and {{scheme}}.

HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308. Default value is 302.

List of IPs or CIDR v4/v6 addresses to filter for from the client side.

Defines whether Edge Services IPs should be matched. If set to true, restricts all connections except for Edge Services.

Type of HTTP filter to match. Extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). Defines where to filter for the http_filter_value. Only supported for HTTP backends.

List of values to filter for.

Name of the HTTP header to filter on if http_header_match was selected in http_filter.

Defines whether to invert the match condition. If set to true, the ACL carries out its action when the condition DOES NOT match.

ACL name.

Action to take when incoming traffic matches an ACL filter.

Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).

ACL match filter object. One of ip_subnet, ips_edge_services or http_filter and http_filter_value are required.

ACL description.

Backend ID.

Name of the backend.

Protocol used by the backend when forwarding traffic to backend servers.

Port used by the backend when forwarding traffic to backend servers.

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

Cookie name for cookie-based sticky sessions.

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

List of IP addresses of backend servers attached to this backend.

Load Balancer the backend is attached to.

Maximum allowed time for a backend server to process a request. (in milliseconds)

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Action to take when a backend server is marked as down.

Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.

Date at which the backend was created. (RFC 3339 format)

Date at which the backend was updated. (RFC 3339 format)

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

Defines whether the server certificate verification should be ignored.

Whether to use another backend server on each attempt.

Number of retries when a backend server connection failed.

Maximum number of connections allowed per backend server.

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

ID of your Load Balancer's underlying Instance.

Backend ID.

IPv4 or IPv6 address of the backend server.

Server operational state (stopped/starting/running/stopping).

Time since last operational change. (RFC 3339 format)

Last health check status (unknown/neutral/failed/passed/condpass).

Certificate type (Let's Encrypt or custom).

Certificate ID.

Main domain name of certificate.

Alternative domain names.

Identifier (SHA-1) of the certificate.

Lower validity bound. (RFC 3339 format)

Upper validity bound. (RFC 3339 format)

Certificate status.

Load Balancer object the certificate is attached to.

Certificate name.

Date on which the certificate was created. (RFC 3339 format)

Date on which the certificate was last updated. (RFC 3339 format)

Additional information about the certificate status (useful in case of certificate generation failure, for example).

Full PEM-formatted certificate, consisting of the entire certificate chain including public key, private key, and (optionally) Certificate Authorities.

Main domain name of certificate (this domain must exist and resolve to your Load Balancer IP address).

Alternative domain names (all domain names must exist and resolve to your Load Balancer IP address).

Frontend ID.

Name of the frontend.

Port the frontend listens on.

Backend object the frontend is attached to.

Load Balancer object the frontend is attached to.

Maximum allowed inactivity time on the client side. (in milliseconds)

List of SSL/TLS certificate IDs to bind to the frontend.

Date on which the frontend was created. (RFC 3339 format)

Date on which the frontend was last updated. (RFC 3339 format)

Defines whether to enable HTTP/3 protocol on the frontend.

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

Defines whether to enable access logs on the frontend.

Port to use for the backend server health check.

Time to wait between two consecutive health checks. (in milliseconds)

Maximum time a backend server has to reply to the health check. (in milliseconds)

Number of consecutive unsuccessful health checks after which the server will be considered dead.

Object to configure a basic TCP health check.

Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.

Object to configure a PostgreSQL health check.

Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.

Object to configure a Redis health check. The response is analyzed to find the +PONG response message.

Object to configure an HTTP health check.

Object to configure an HTTPS health check.

Defines whether proxy protocol should be activated for the health check.

Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). (in seconds)

HTTP path used for the health check. The HTTP path to use when performing a health check on backend servers.

HTTP method used for the health check. The HTTP method used when performing a health check on backend servers.

HTTP response code expected for a successful health check. The HTTP response code that should be returned for a health check to be considered successful.

HTTP host header used for the health check. The HTTP host header used when performing a health check on backend servers.

HTTP path used for the health check. The HTTP path to use when performing a health check on backend servers.

HTTP method used for the health check. The HTTP method used when performing a health check on backend servers.

HTTP response code expected for a successful health check. The HTTP response code that should be returned for a health check to be considered successful.

HTTP host header used for the health check. The HTTP host header used when performing a health check on backend servers.

SNI used for SSL health checks. The SNI value used when performing a health check on backend servers over SSL.

MySQL user to use for the health check.

PostgreSQL user to use for the health check.

Underlying Instance ID.

Instance status.

Instance IP address.

Date on which the Instance was created. (RFC 3339 format)

Date on which the Instance was last updated. (RFC 3339 format)

The zone the Instance is in.

IP address ID.

IP address.

Organization ID of the Scaleway Organization the IP address is in.

Project ID of the Scaleway Project the IP address is in.

Load Balancer ID.

Reverse DNS (domain name) of the IP address.

IP tags.

The zone the IP address is in.

Underlying Instance ID.

Load Balancer name.

Load Balancer description.

Load Balancer status.

List of underlying Instances.

Scaleway Organization ID.

Scaleway Project ID.

List of IP addresses attached to the Load Balancer.

Load Balancer tags.

Number of frontends the Load Balancer has.

Number of backends the Load Balancer has.

Load Balancer offer type.

Subscriber information.

Determines the minimal SSL version which needs to be supported on client side.

Date on which the Load Balancer was created. (RFC 3339 format)

Date on which the Load Balancer was last updated. (RFC 3339 format)

Number of Private Networks attached to the Load Balancer.

Number of routes configured on the Load Balancer.

The zone the Load Balancer is in.

List of objects containing Load Balancer statistics.

Load Balancer commercial offer type name.

Current stock status for a given Load Balancer type.

Maximum bandwidth for a given Load Balancer type.

Ability to handle backend servers outside Scaleway for a given Load Balancer type.

Load Balancer commercial offer type description.

The zone the Load Balancer stock is in.

List of ACL objects.

The total number of objects.

List of objects containing backend server statistics.

The total number of objects.

List of backend objects of a given Load Balancer.

Total count of backend objects, without pagination.

List of certificate objects.

The total number of objects.

List of frontend objects of a given Load Balancer.

Total count of frontend objects, without pagination.

List of IP address objects.

Total count of IP address objects, without pagination.

List of Private Network objects attached to the Load Balancer.

Total number of objects in the response.

List of Load Balancer commercial offer type objects.

Total number of Load Balancer offer type objects.

List of Load Balancer objects.

The total number of Load Balancer objects.

List of route objects.

The total number of route objects.

List of subscriber objects.

The total number of objects.

Load Balancer object which is attached to the Private Network.

IPAM IDs of the booked IP addresses. (UUID format)

Private Network ID.

Status of Private Network connection.

Date on which the Private Network was created. (RFC 3339 format)

Date on which the PN was last updated. (RFC 3339 format)

Route ID.

ID of the source frontend.

ID of the target backend.

Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.

Date on which the route was created. (RFC 3339 format)

Date on which the route was last updated. (RFC 3339 format)

Server Name Indication (SNI) value to match. Value to match in the Server Name Indication TLS extension (SNI) field from an incoming connection made via an SSL/TLS transport layer. This field should be set for routes on TCP Load Balancers.

HTTP host header to match. Value to match in the HTTP Host request header from an incoming request. This field should be set for routes on HTTP Load Balancers.

If true, all subdomains will match.

Path begin value to match. Value to match in the URL beginning path from an incoming request.

List of ACL objects.

The total number of ACL objects.

Subscriber ID.

Subscriber name.

Email address of subscriber.

Webhook URI of subscriber.

Email address to send alerts to.

URI to receive POST requests.