A route stage is part of a pipeline. It allows you to configure routes towards other stages of the Edge Services pipeline, based on a defined set of rules (using HTTP method or path). For now, the main use case for a route stage is to allow all requests that match certain rules to bypass a WAF stage and route directly to the backend stage. More functionality for the route stage is planned for the future. Note that including a route stage in your pipeline is optional.
List route stages
List all route stages, for a given pipeline. By default, the route stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
pipeline_idPipeline ID to filter for. Only route stages from this pipeline will be returned.
query Parameters
order_bySort order of route stages in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of route stages to return per page.
List route stages › Responses
Paginated list of summarized route stages.
total_countCount of all route stages matching the requested criteria.
Create route stage
Create a new route stage. You must specify the waf_stage_id or backend_stage_id fields to customize the route.
path Parameters
pipeline_idPipeline ID the route stage belongs to. (UUID format)
Create route stage › Request Body
waf_stage_idID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
backend_stage_idID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
Create route stage › Responses
idID of the route stage.
pipeline_idPipeline ID the route stage belongs to.
waf_stage_idID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
backend_stage_idID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
statusCurrent status of the stage.
created_atDate the route stage was created. (RFC 3339 format)
updated_atDate the route stage was last updated. (RFC 3339 format)
Get route stage
Retrieve information about an existing route stage, specified by its route_stage_id. The summary of the route stage (without route rules) is returned in the response object.
path Parameters
route_stage_idID of the requested route stage.
Get route stage › Responses
idID of the route stage.
pipeline_idPipeline ID the route stage belongs to.
waf_stage_idID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
backend_stage_idID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
statusCurrent status of the stage.
created_atDate the route stage was created. (RFC 3339 format)
updated_atDate the route stage was last updated. (RFC 3339 format)
Update route stage
Update the parameters of an existing route stage, specified by its route_stage_id.
path Parameters
route_stage_idID of the route stage to update.
Update route stage › Request Body
waf_stage_idID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
backend_stage_idID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
Update route stage › Responses
idID of the route stage.
pipeline_idPipeline ID the route stage belongs to.
waf_stage_idID of the WAF stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
backend_stage_idID of the backend stage HTTP requests should be forwarded to when no rules are matched. (UUID format)
statusCurrent status of the stage.
created_atDate the route stage was created. (RFC 3339 format)
updated_atDate the route stage was last updated. (RFC 3339 format)
List route rules
List all route rules of an existing route stage, specified by its route_stage_id.
path Parameters
route_stage_idRoute stage ID to filter for. Only route rules from this route stage will be returned.
List route rules › Responses
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.
total_countCount of all route rules matching the requested criteria.
Set route rules
Set the rules of an existing route stage, specified by its route_stage_id.
path Parameters
route_stage_idID of the route stage to update. (UUID format)
Set route rules › Request Body
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.
Set route rules › Responses
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.
Add route rules
Add route rules to an existing route stage, specified by its route_stage_id.
path Parameters
route_stage_idID of the route stage to update. (UUID format)
Add route rules › Request Body
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.
after_positionAdd rules after the given position.
before_positionAdd rules before the given position.
Add route rules › Responses
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by waf_stage_id or backend_stage_id.