The Load Balancer frontend object. It listens on a configured port and forward requests to one or several backends. You can create multiple frontends for any given Load Balancer, each listening on a different port, and choose to add certificates to them if you wish. Use the frontends endpoint to create, list, manage and delete frontends.
Get a frontend
Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has.
path Parameters
zoneThe zone you want to target
frontend_idFrontend ID.
Get a frontend › Responses
idFrontend ID.
nameName of the frontend.
inbound_portPort the frontend listens on.
Backend object the frontend is attached to.
Load Balancer object the frontend is attached to.
timeout_clientMaximum allowed inactivity time on the client side. (in milliseconds)
certificate_idsList of SSL/TLS certificate IDs to bind to the frontend.
created_atDate on which the frontend was created. (RFC 3339 format)
updated_atDate on which the frontend was last updated. (RFC 3339 format)
enable_http3Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limitRate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
enable_access_logsDefines whether to enable access logs on the frontend.
Certificate, deprecated in favor of certificate_ids array.
Update a frontend
Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. Note that the request type is PUT and not PATCH. You must set all parameters.
path Parameters
zoneThe zone you want to target
frontend_idFrontend ID.
Update a frontend › Request Body
nameFrontend name.
inbound_portPort the frontend should listen on.
backend_idBackend ID (ID of the backend the frontend should pass traffic to).
timeout_clientMaximum allowed inactivity time on the client side. (in milliseconds)
certificate_idsList of SSL/TLS certificate IDs to bind to the frontend.
enable_http3Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limitRate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
enable_access_logsDefines whether to enable access logs on the frontend.
certificate_idCertificate ID, deprecated in favor of certificate_ids array.
Update a frontend › Responses
idFrontend ID.
nameName of the frontend.
inbound_portPort the frontend listens on.
Backend object the frontend is attached to.
Load Balancer object the frontend is attached to.
timeout_clientMaximum allowed inactivity time on the client side. (in milliseconds)
certificate_idsList of SSL/TLS certificate IDs to bind to the frontend.
created_atDate on which the frontend was created. (RFC 3339 format)
updated_atDate on which the frontend was last updated. (RFC 3339 format)
enable_http3Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limitRate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
enable_access_logsDefines whether to enable access logs on the frontend.
Certificate, deprecated in favor of certificate_ids array.
Delete a frontend
Delete a given frontend, specified by its frontend ID. This action is irreversible and cannot be undone.
path Parameters
zoneThe zone you want to target
frontend_idID of the frontend to delete.
Delete a frontend › Responses
List frontends of a given Load Balancer
List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
query Parameters
nameName of the frontend to filter for.
order_bySort order of frontends in the response.
pageThe page number to return, from the paginated results.
page_sizeNumber of frontends to return.
List frontends of a given Load Balancer › Responses
List of frontend objects of a given Load Balancer.
total_countTotal count of frontend objects, without pagination.
Create a frontend in a given Load Balancer
Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID (ID of the Load Balancer to attach the frontend to).
Create a frontend in a given Load Balancer › Request Body
nameName for the frontend.
inbound_portPort the frontend should listen on.
backend_idBackend ID (ID of the backend the frontend should pass traffic to).
timeout_clientMaximum allowed inactivity time on the client side. (in milliseconds)
certificate_idsList of SSL/TLS certificate IDs to bind to the frontend.
enable_http3Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limitRate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
enable_access_logsDefines whether to enable access logs on the frontend.
certificate_idCertificate ID, deprecated in favor of certificate_ids array.
Create a frontend in a given Load Balancer › Responses
idFrontend ID.
nameName of the frontend.
inbound_portPort the frontend listens on.
Backend object the frontend is attached to.
Load Balancer object the frontend is attached to.
timeout_clientMaximum allowed inactivity time on the client side. (in milliseconds)
certificate_idsList of SSL/TLS certificate IDs to bind to the frontend.
created_atDate on which the frontend was created. (RFC 3339 format)
updated_atDate on which the frontend was last updated. (RFC 3339 format)
enable_http3Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limitRate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
enable_access_logsDefines whether to enable access logs on the frontend.
Certificate, deprecated in favor of certificate_ids array.