Backend stages

Download schema

A backend stage is part of a pipeline. It defines the source of the content that Edge Services will serve to clients. It could be either a Scaleway Object StorageOpen in new context bucket ("S3"), a Scaleway Load BalancerOpen in new context, a Scaleway Serverless ContainerOpen in new context or a Scaleway Serverless FunctionOpen in new context.

Get backend stage

GET

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Retrieve information about an existing backend stage, specified by its backend_stage_id. Its full details, including scaleway_s3 or scaleway_lb, are returned in the response object.

Get backend stage › path Parameters

backend_stage_id

string · required

ID of the requested backend stage.

Get backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

GET/edge-services/v1beta1/backend-stages/{backend_stage_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/edge-services/v1beta1/backend-stages/{backend_stage_id}"

Example Responses

{
  "id": "id",
  "pipeline_id": "pipeline_id",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "scaleway_s3": {
    "bucket_name": "bucket_name",
    "bucket_region": "bucket_region",
    "is_website": true
  },
  "scaleway_lb": {
    "lbs": [
      {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "zone",
        "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
        "is_ssl": true,
        "domain_name": "domain_name",
        "has_websocket": true
      }
    ]
  },
  "scaleway_serverless_container": {
    "region": "region",
    "container_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "scaleway_serverless_function": {
    "region": "region",
    "function_id": "6170692e-7363-616c-6577-61792e636f6d"
  }
}

json

application/json

Delete backend stage

DELETE

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Delete an existing backend stage, specified by its backend_stage_id. Deleting a backend stage is permanent, and cannot be undone.

Delete backend stage › path Parameters

backend_stage_id

string · required

ID of the backend stage to delete.

Delete backend stage › Responses

No data returned

Update backend stage

PATCH

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Update the parameters of an existing backend stage, specified by its backend_stage_id.

Update backend stage › path Parameters

backend_stage_id

string · required

ID of the backend stage to update.

Update backend stage › Request Body

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

pipeline_id

string

Pipeline ID the Backend stage belongs to.

Update backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

PATCH/edge-services/v1beta1/backend-stages/{backend_stage_id}

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

Example Request Body

{
  "scaleway_s3": {
    "bucket_name": "bucket_name",
    "bucket_region": "bucket_region",
    "is_website": true
  },
  "scaleway_lb": {
    "lbs": [
      {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "zone",
        "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
        "is_ssl": true,
        "domain_name": "domain_name",
        "has_websocket": true
      }
    ]
  },
  "scaleway_serverless_container": {
    "region": "region",
    "container_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "scaleway_serverless_function": {
    "region": "region",
    "function_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "pipeline_id": "pipeline_id"
}

json

Example Responses

{
  "id": "id",
  "pipeline_id": "pipeline_id",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "scaleway_s3": {
    "bucket_name": "bucket_name",
    "bucket_region": "bucket_region",
    "is_website": true
  },
  "scaleway_lb": {
    "lbs": [
      {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "zone",
        "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
        "is_ssl": true,
        "domain_name": "domain_name",
        "has_websocket": true
      }
    ]
  },
  "scaleway_serverless_container": {
    "region": "region",
    "container_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "scaleway_serverless_function": {
    "region": "region",
    "function_id": "6170692e-7363-616c-6577-61792e636f6d"
  }
}

json

application/json

List backend stages

GET

https://api.scaleway.com

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

List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List backend stages › path Parameters

pipeline_id

string · required

Pipeline ID to filter for. Only backend stages from this pipeline will be returned.

List backend stages › query Parameters

order_by

string · enum

Sort order of backend stages in the response.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of backend stages to return per page.

bucket_name

string

Bucket name to filter for. Only backend stages from this Bucket will be returned.

bucket_region

string

Bucket region to filter for. Only backend stages with buckets in this region will be returned.

lb_id

string

Load Balancer ID to filter for. Only backend stages with this Load Balancer will be returned.

List backend stages › Responses

200

scaleway.edge_services.v1beta1.ListBackendStagesResponse

scaleway.edge_services.v1beta1.BackendStage[]

Paginated list of backend stages.

total_count

integer · uint64

Count of all backend stages matching the requested criteria.

GET/edge-services/v1beta1/pipelines/{pipeline_id}/backend-stages

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/edge-services/v1beta1/pipelines/{pipeline_id}/backend-stages"

Example Responses

{
  "stages": [
    {
      "id": "id",
      "pipeline_id": "pipeline_id",
      "status": "unknown_status",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "scaleway_s3": {
        "bucket_name": "bucket_name",
        "bucket_region": "bucket_region",
        "is_website": true
      },
      "scaleway_lb": {
        "lbs": [
          {
            "id": "6170692e-7363-616c-6577-61792e636f6d",
            "zone": "zone",
            "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
            "is_ssl": true,
            "domain_name": "domain_name",
            "has_websocket": true
          }
        ]
      },
      "scaleway_serverless_container": {
        "region": "region",
        "container_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "scaleway_serverless_function": {
        "region": "region",
        "function_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "total_count": 0
}

json

application/json

Create backend stage

POST

https://api.scaleway.com

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

Create a new backend stage. You must specify either a scaleway_s3 (for a Scaleway Object Storage bucket) or scaleway_lb (for a Scaleway Load Balancer) field to configure the origin.

Create backend stage › path Parameters

pipeline_id

string · required

Pipeline ID the Backend stage belongs to.

Create backend stage › Request Body

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

Create backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

POST/edge-services/v1beta1/pipelines/{pipeline_id}/backend-stages

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

Example Request Body

{
  "scaleway_s3": {
    "bucket_name": "bucket_name",
    "bucket_region": "bucket_region",
    "is_website": true
  },
  "scaleway_lb": {
    "lbs": [
      {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "zone",
        "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
        "is_ssl": true,
        "domain_name": "domain_name",
        "has_websocket": true
      }
    ]
  },
  "scaleway_serverless_container": {
    "region": "region",
    "container_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "scaleway_serverless_function": {
    "region": "region",
    "function_id": "6170692e-7363-616c-6577-61792e636f6d"
  }
}

json

Example Responses

{
  "id": "id",
  "pipeline_id": "pipeline_id",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "scaleway_s3": {
    "bucket_name": "bucket_name",
    "bucket_region": "bucket_region",
    "is_website": true
  },
  "scaleway_lb": {
    "lbs": [
      {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "zone",
        "frontend_id": "6170692e-7363-616c-6577-61792e636f6d",
        "is_ssl": true,
        "domain_name": "domain_name",
        "has_websocket": true
      }
    ]
  },
  "scaleway_serverless_container": {
    "region": "region",
    "container_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "scaleway_serverless_function": {
    "region": "region",
    "function_id": "6170692e-7363-616c-6577-61792e636f6d"
  }
}

json

application/json

Route stages Purge requests

Get backend stage

GET

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Retrieve information about an existing backend stage, specified by its backend_stage_id. Its full details, including scaleway_s3 or scaleway_lb, are returned in the response object.

Get backend stage › path Parameters

backend_stage_id

string · required

ID of the requested backend stage.

Get backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

Delete backend stage

DELETE

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Delete an existing backend stage, specified by its backend_stage_id. Deleting a backend stage is permanent, and cannot be undone.

Delete backend stage › path Parameters

backend_stage_id

string · required

ID of the backend stage to delete.

Delete backend stage › Responses

No data returned

Update backend stage

PATCH

https://api.scaleway.com

/edge-services/v1beta1/backend-stages/{backend_stage_id}

Update the parameters of an existing backend stage, specified by its backend_stage_id.

Update backend stage › path Parameters

backend_stage_id

string · required

ID of the backend stage to update.

Update backend stage › Request Body

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

pipeline_id

string

Pipeline ID the Backend stage belongs to.

Update backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

List backend stages

GET

https://api.scaleway.com

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

List backend stages › path Parameters

pipeline_id

string · required

Pipeline ID to filter for. Only backend stages from this pipeline will be returned.

List backend stages › query Parameters

order_by

string · enum

Sort order of backend stages in the response.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of backend stages to return per page.

bucket_name

string

Bucket name to filter for. Only backend stages from this Bucket will be returned.

bucket_region

string

Bucket region to filter for. Only backend stages with buckets in this region will be returned.

lb_id

string

Load Balancer ID to filter for. Only backend stages with this Load Balancer will be returned.

List backend stages › Responses

200

scaleway.edge_services.v1beta1.ListBackendStagesResponse

scaleway.edge_services.v1beta1.BackendStage[]

Paginated list of backend stages.

total_count

integer · uint64

Count of all backend stages matching the requested criteria.

Create backend stage

POST

https://api.scaleway.com

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

Create a new backend stage. You must specify either a scaleway_s3 (for a Scaleway Object Storage bucket) or scaleway_lb (for a Scaleway Load Balancer) field to configure the origin.

Create backend stage › path Parameters

pipeline_id

string · required

Pipeline ID the Backend stage belongs to.

Create backend stage › Request Body

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.

Create backend stage › Responses

200

scaleway.edge_services.v1beta1.BackendStage

id

string

ID of the backend stage.

pipeline_id

string

Pipeline ID the backend stage belongs to.

status

string · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string · date-time

Date the backend stage was created. (RFC 3339 format)

updated_at

string · date-time

Date the backend stage was last updated. (RFC 3339 format)

object

Scaleway Object Storage origin bucket (S3) linked to the backend stage.

object

Scaleway Load Balancer origin linked to the backend stage.

object

Scaleway Serverless container origin linked to the backend stage.

object

Scaleway Serverless function origin linked to the backend stage.