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
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.
path Parameters
cache_stage_idID of the requested cache stage.
Get cache stage › Responses
idID of the cache stage.
pipeline_idPipeline ID the cache stage belongs to.
fallback_ttlTime To Live (TTL) in seconds. Defines how long content is cached. (in seconds)
include_cookiesDefines whether responses to requests with cookies must be stored in the cache.
statusCurrent status of the stage.
created_atDate the cache stage was created. (RFC 3339 format)
updated_atDate the cache stage was last updated. (RFC 3339 format)
waf_stage_id(UUID format)
backend_stage_idBackend stage ID the cache stage is linked to. (UUID format)
route_stage_id(UUID format)
Update cache stage
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.
path Parameters
cache_stage_idID of the cache stage to update.
Update cache stage › Request Body
fallback_ttlTime To Live (TTL) in seconds. Defines how long content is cached. (in seconds)
include_cookiesDefines whether responses to requests with cookies must be stored in the cache.
backend_stage_idBackend stage ID the cache stage will be linked to. (UUID format)
waf_stage_id(UUID format)
route_stage_id(UUID format)
Update cache stage › Responses
idID of the cache stage.
pipeline_idPipeline ID the cache stage belongs to.
fallback_ttlTime To Live (TTL) in seconds. Defines how long content is cached. (in seconds)
include_cookiesDefines whether responses to requests with cookies must be stored in the cache.
statusCurrent status of the stage.
created_atDate the cache stage was created. (RFC 3339 format)
updated_atDate the cache stage was last updated. (RFC 3339 format)
waf_stage_id(UUID format)
backend_stage_idBackend stage ID the cache stage is linked to. (UUID format)
route_stage_id(UUID format)
List 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.
path Parameters
pipeline_idPipeline ID to filter for. Only cache stages from this pipeline will be returned.
query Parameters
order_bySort order of cache stages in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of cache stages to return per page.
List cache stages › Responses
Paginated list of cache stages.
total_countCount of all cache stages matching the requested criteria.
Create cache stage
Create a new cache stage. You must specify the fallback_ttl field to customize the TTL of the cache.
path Parameters
pipeline_idPipeline ID the Cache stage belongs to. (UUID format)
Create cache stage › Request Body
fallback_ttlTime To Live (TTL) in seconds. Defines how long content is cached. (in seconds)
include_cookiesDefines whether responses to requests with cookies must be stored in the cache.
backend_stage_idBackend stage ID the cache stage will be linked to. (UUID format)
waf_stage_id(UUID format)
route_stage_id(UUID format)
Create cache stage › Responses
idID of the cache stage.
pipeline_idPipeline ID the cache stage belongs to.
fallback_ttlTime To Live (TTL) in seconds. Defines how long content is cached. (in seconds)
include_cookiesDefines whether responses to requests with cookies must be stored in the cache.
statusCurrent status of the stage.
created_atDate the cache stage was created. (RFC 3339 format)
updated_atDate the cache stage was last updated. (RFC 3339 format)
waf_stage_id(UUID format)
backend_stage_idBackend stage ID the cache stage is linked to. (UUID format)
route_stage_id(UUID format)