Pipelines

Download schema

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

GET

https://api.scaleway.com

/edge-services/v1beta1/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.

List pipelines › query Parameters

order_by

scaleway.edge_services.v1beta1.ListPipelinesRequest.OrderBy · enum

Sort order of pipelines in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of pipelines to return per page.

name

string

Pipeline name to filter for. Only pipelines with this string within their name will be returned.

organization_id

string

Organization ID to filter for. Only pipelines from this Organization will be returned.

project_id

string

Project ID to filter for. Only pipelines from this Project will be returned.

has_backend_stage_lb

boolean

Filter on backend stage. Only pipelines with a Load Balancer origin will be returned.

List pipelines › Responses

200

scaleway.edge_services.v1beta1.ListPipelinesResponse

scaleway.edge_services.v1beta1.Pipeline[]

Paginated list of pipelines.

total_count

integer · uint64

Count of all pipelines matching the requested criteria.

Create pipeline

POST

https://api.scaleway.com

/edge-services/v1beta1/pipelines

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_id

string · required

Project ID in which the pipeline will be created. (UUID format)

name

string · required

Name of the pipeline.

description

string · required

Description of the pipeline.

Create pipeline › Responses

200

scaleway.edge_services.v1beta1.Pipeline

id

string

ID of the pipeline.

name

string

Name of the pipeline.

description

string

Description of the pipeline.

status

scaleway.edge_services.v1beta1.Pipeline.Status · enum

Status of the pipeline.

Enum values:

unknown_status

ready

error

pending

warning

locked

Default: unknown_status

scaleway.edge_services.v1beta1.Pipeline.Error[]

Errors of the pipeline.

project_id

string

Project ID of the pipeline. (UUID format)

organization_id

string

Organization ID of the pipeline.

created_at

string | null · date-time

Date the pipeline was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the pipeline was last updated. (RFC 3339 format)

POST/edge-services/v1beta1/pipelines

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/edge-services/v1beta1/pipelines"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "status": "unknown_status",
  "errors": [
    {
      "stage": "unknown_stage",
      "code": "unknown_code",
      "severity": "unknown_severity",
      "message": "message",
      "type": "unknown_type"
    }
  ],
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "organization_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Get pipeline

GET

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}

Retrieve information about an existing pipeline, specified by its pipeline_id. Its full details, including errors, are returned in the response object.

Get pipeline › path Parameters

pipeline_id

string · required

ID of the requested pipeline.

Get pipeline › Responses

200

scaleway.edge_services.v1beta1.Pipeline

id

string

ID of the pipeline.

name

string

Name of the pipeline.

description

string

Description of the pipeline.

status

scaleway.edge_services.v1beta1.Pipeline.Status · enum

Status of the pipeline.

Enum values:

unknown_status

ready

error

pending

warning

locked

Default: unknown_status

scaleway.edge_services.v1beta1.Pipeline.Error[]

Errors of the pipeline.

project_id

string

Project ID of the pipeline. (UUID format)

organization_id

string

Organization ID of the pipeline.

created_at

string | null · date-time

Date the pipeline was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the pipeline was last updated. (RFC 3339 format)

Update pipeline

PATCH

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}

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.

Update pipeline › path Parameters

pipeline_id

string · required

ID of the pipeline to update.

Update pipeline › Request Body

name

string | null

Name of the pipeline.

description

string | null

Description of the pipeline.

Update pipeline › Responses

200

scaleway.edge_services.v1beta1.Pipeline

id

string

ID of the pipeline.

name

string

Name of the pipeline.

description

string

Description of the pipeline.

status

scaleway.edge_services.v1beta1.Pipeline.Status · enum

Status of the pipeline.

Enum values:

unknown_status

ready

error

pending

warning

locked

Default: unknown_status

scaleway.edge_services.v1beta1.Pipeline.Error[]

Errors of the pipeline.

project_id

string

Project ID of the pipeline. (UUID format)

organization_id

string

Organization ID of the pipeline.

created_at

string | null · date-time

Date the pipeline was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the pipeline was last updated. (RFC 3339 format)

PATCH/edge-services/v1beta1/pipelines/{pipeline_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/edge-services/v1beta1/pipelines/{pipeline_id}"

Example Request Body

{
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "status": "unknown_status",
  "errors": [
    {
      "stage": "unknown_stage",
      "code": "unknown_code",
      "severity": "unknown_severity",
      "message": "message",
      "type": "unknown_type"
    }
  ],
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "organization_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Delete pipeline

DELETE

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}

Delete an existing pipeline, specified by its pipeline_id. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted.

Delete pipeline › path Parameters

pipeline_id

string · required

ID of the pipeline to delete.

Delete pipeline › Responses

No data returned

List Head stage for your pipeline.

GET

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}/head-stages

List Head stage for your pipeline. › path Parameters

pipeline_id

string · required

ID of the pipeline to update. (UUID format)

List Head stage for your pipeline. › query Parameters

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of head stages to return per page.

List Head stage for your pipeline. › Responses

200

scaleway.edge_services.v1beta1.ListHeadStagesResponse

scaleway.edge_services.v1beta1.ListHeadStagesResponse.HeadStage[]

Number of head stages to return per page.

total_count

integer · uint64

Count 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.

POST

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}/set-head-stage

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).

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. › path Parameters

pipeline_id

string · required

ID 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

200

scaleway.edge_services.v1beta1.HeadStageResponse

scaleway.edge_services.v1beta1.HeadStageResponse.HeadStage

Modified or created head stage.

Plans DNS stages