Cache stages

Download schema

A cache stage is part of a pipeline. It allows you to cache your origin's content, so it will be served directly to users from a cache on Edge Services' servers, enhancing performance. Note that including a cache stage in your pipeline is optional.

Get cache stage

GET

https://api.scaleway.com

/edge-services/v1beta1/cache-stages/{cache_stage_id}

Retrieve information about an existing cache stage, specified by its cache_stage_id. Its full details, including Time To Live (TTL), are returned in the response object.

Get cache stage › path Parameters

cache_stage_id

string · required

ID of the requested cache stage.

Get cache stage › Responses

200

scaleway.edge_services.v1beta1.CacheStage

id

string

ID of the cache stage.

pipeline_id

string

Pipeline ID the cache stage belongs to.

fallback_ttl

string | null

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

include_cookies

boolean

Defines whether responses to requests with cookies must be stored in the cache.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

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

updated_at

string | null · date-time

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

waf_stage_id

string | null

(UUID format)

backend_stage_id

string | null

Backend stage ID the cache stage is linked to. (UUID format)

route_stage_id

string | null

(UUID format)

Update cache stage

PATCH

https://api.scaleway.com

/edge-services/v1beta1/cache-stages/{cache_stage_id}

Update the parameters of an existing cache stage, specified by its cache_stage_id. Parameters which can be updated include the fallback_ttl, include_cookies and backend_stage_id.

Update cache stage › path Parameters

cache_stage_id

string · required

ID of the cache stage to update.

Update cache stage › Request Body

fallback_ttl

string | null

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

include_cookies

boolean | null

Defines whether responses to requests with cookies must be stored in the cache.

backend_stage_id

string | null

Backend stage ID the cache stage will be linked to. (UUID format)

waf_stage_id

string | null

(UUID format)

route_stage_id

string | null

(UUID format)

Update cache stage › Responses

200

scaleway.edge_services.v1beta1.CacheStage

id

string

ID of the cache stage.

pipeline_id

string

Pipeline ID the cache stage belongs to.

fallback_ttl

string | null

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

include_cookies

boolean

Defines whether responses to requests with cookies must be stored in the cache.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

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

updated_at

string | null · date-time

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

waf_stage_id

string | null

(UUID format)

backend_stage_id

string | null

Backend stage ID the cache stage is linked to. (UUID format)

route_stage_id

string | null

(UUID format)

PATCH/edge-services/v1beta1/cache-stages/{cache_stage_id}

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

Example Request Body

{
  "fallback_ttl": "2.5s",
  "include_cookies": true,
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "waf_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "route_stage_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "id",
  "pipeline_id": "pipeline_id",
  "fallback_ttl": "2.5s",
  "include_cookies": true,
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "waf_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "route_stage_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

application/json

Delete cache stage

DELETE

https://api.scaleway.com

/edge-services/v1beta1/cache-stages/{cache_stage_id}

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

Delete cache stage › path Parameters

cache_stage_id

string · required

ID of the cache stage to delete.

Delete cache stage › Responses

No data returned

List cache stages

GET

https://api.scaleway.com

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

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

List cache stages › path Parameters

pipeline_id

string · required

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

List cache stages › query Parameters

order_by

scaleway.edge_services.v1beta1.ListCacheStagesRequest.OrderBy · enum

Sort order of cache 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 cache stages to return per page.

List cache stages › Responses

200

scaleway.edge_services.v1beta1.ListCacheStagesResponse

scaleway.edge_services.v1beta1.CacheStage[]

Paginated list of cache stages.

total_count

integer · uint64

Count of all cache stages matching the requested criteria.

Create cache stage

POST

https://api.scaleway.com

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

Create a new cache stage. You must specify the fallback_ttl field to customize the TTL of the cache.

Create cache stage › path Parameters

pipeline_id

string · required

Pipeline ID the Cache stage belongs to. (UUID format)

Create cache stage › Request Body

fallback_ttl

string | null

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

include_cookies

boolean | null

Defines whether responses to requests with cookies must be stored in the cache.

backend_stage_id

string | null

Backend stage ID the cache stage will be linked to. (UUID format)

waf_stage_id

string | null

(UUID format)

route_stage_id

string | null

(UUID format)

Create cache stage › Responses

200

scaleway.edge_services.v1beta1.CacheStage

id

string

ID of the cache stage.

pipeline_id

string

Pipeline ID the cache stage belongs to.

fallback_ttl

string | null

Time To Live (TTL) in seconds. Defines how long content is cached. (in seconds)

include_cookies

boolean

Defines whether responses to requests with cookies must be stored in the cache.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

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

updated_at

string | null · date-time

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

waf_stage_id

string | null

(UUID format)

backend_stage_id

string | null

Backend stage ID the cache stage is linked to. (UUID format)

route_stage_id

string | null

(UUID format)

POST/edge-services/v1beta1/pipelines/{pipeline_id}/cache-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}/cache-stages"

Example Request Body

{
  "fallback_ttl": "2.5s",
  "include_cookies": true,
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "waf_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "route_stage_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "id",
  "pipeline_id": "pipeline_id",
  "fallback_ttl": "2.5s",
  "include_cookies": true,
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "waf_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "route_stage_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

application/json

TLS stages WAF stages