The main Edge Services object. A pipeline is made up of ordered stages and represents how an HTTP request will be processed, from the source (client) to the destination (origin).
List pipelines
List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
query Parameters
order_bySort order of pipelines in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of pipelines to return per page.
namePipeline name to filter for. Only pipelines with this string within their name will be returned.
organization_idOrganization ID to filter for. Only pipelines from this Organization will be returned.
project_idProject ID to filter for. Only pipelines from this Project will be returned.
has_backend_stage_lbFilter on backend stage. Only pipelines with a Load Balancer origin will be returned.
List pipelines › Responses
Paginated list of pipelines.
total_countCount of all pipelines matching the requested criteria.
Create pipeline
Create a new pipeline. You must specify a dns_stage_id to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
Create pipeline › Request Body
project_idProject ID in which the pipeline will be created. (UUID format)
nameName of the pipeline.
descriptionDescription of the pipeline.
Create pipeline › Responses
idID of the pipeline.
nameName of the pipeline.
descriptionDescription of the pipeline.
statusStatus of the pipeline.
Errors of the pipeline.
project_idProject ID of the pipeline. (UUID format)
organization_idOrganization ID of the pipeline.
created_atDate the pipeline was created. (RFC 3339 format)
updated_atDate the pipeline was last updated. (RFC 3339 format)
Get pipeline
Retrieve information about an existing pipeline, specified by its pipeline_id. Its full details, including errors, are returned in the response object.
path Parameters
pipeline_idID of the requested pipeline.
Get pipeline › Responses
idID of the pipeline.
nameName of the pipeline.
descriptionDescription of the pipeline.
statusStatus of the pipeline.
Errors of the pipeline.
project_idProject ID of the pipeline. (UUID format)
organization_idOrganization ID of the pipeline.
created_atDate the pipeline was created. (RFC 3339 format)
updated_atDate the pipeline was last updated. (RFC 3339 format)
Update pipeline
Update the parameters of an existing pipeline, specified by its pipeline_id. Parameters which can be updated include the name, description and dns_stage_id.
path Parameters
pipeline_idID of the pipeline to update.
Update pipeline › Request Body
nameName of the pipeline.
descriptionDescription of the pipeline.
Update pipeline › Responses
idID of the pipeline.
nameName of the pipeline.
descriptionDescription of the pipeline.
statusStatus of the pipeline.
Errors of the pipeline.
project_idProject ID of the pipeline. (UUID format)
organization_idOrganization ID of the pipeline.
created_atDate the pipeline was created. (RFC 3339 format)
updated_atDate the pipeline was last updated. (RFC 3339 format)
List Head stage for your pipeline.
path Parameters
pipeline_idID of the pipeline to update. (UUID format)
query Parameters
pagePage number to return, from the paginated results.
page_sizeNumber of head stages to return per page.
List Head stage for your pipeline. › Responses
Number of head stages to return per page.
total_countCount of all head stages matching the requested pipeline_id.
Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
You must specify either a add_new_head_stage (to add a new head stage), remove_head_stage (to remove a head stage) or swap_head_stage (to replace a head stage).
path Parameters
pipeline_idID of the pipeline to update. (UUID format)
Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created. › Request Body
Add a new head stage.
Remove a head stage.
Replace a head stage with a new one.
Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created. › Responses
Modified or created head stage.