The Load Balancer route object. It represents a configuration on a particular frontend to direct traffic to a particular backend if certain conditions are fulfilled. Conditions must be based on SNI for direction to TCP backends, or HTTP host headers for direction to HTTP backends. Use the routes endpoint to create, edit, list, get and delete your routes.
List all routes
List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
path Parameters
zoneThe zone you want to target
query Parameters
order_bySort order of routes in the response.
page_sizeThe number of route objects to return.
pageThe page number to return, from the paginated results.
frontend_idFrontend ID to filter for, only Routes from this Frontend will be returned.
List all routes › Responses
List of route objects.
total_countThe total number of route objects.
Create a route
Create a new route on a given frontend. To configure a route, specify the backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header).
path Parameters
zoneThe zone you want to target
Create a route › Request Body
frontend_idID of the source frontend to create the route on.
backend_idID of the target backend for the route.
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.
Create a route › Responses
idRoute ID.
frontend_idID of the source frontend.
backend_idID 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.
created_atDate on which the route was created. (RFC 3339 format)
updated_atDate on which the route was last updated. (RFC 3339 format)
Get a route
Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object.
path Parameters
zoneThe zone you want to target
route_idRoute ID.
Get a route › Responses
idRoute ID.
frontend_idID of the source frontend.
backend_idID 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.
created_atDate on which the route was created. (RFC 3339 format)
updated_atDate on which the route was last updated. (RFC 3339 format)
Update a route
Update the configuration of an existing route, specified by its route ID.
path Parameters
zoneThe zone you want to target
route_idRoute ID.
Update a route › Request Body
backend_idID of the target backend for the route.
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.
Update a route › Responses
idRoute ID.
frontend_idID of the source frontend.
backend_idID 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.
created_atDate on which the route was created. (RFC 3339 format)
updated_atDate on which the route was last updated. (RFC 3339 format)
Delete a route
Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.
path Parameters
zoneThe zone you want to target
route_idRoute ID.