Scaleway logo
Edge Services API
Edge Services API

Purge requests

Download schema

A purge request allows you to remove content from the cache (if a cache stage has been created). You can choose to purge the entire cache, or limit the purge to specified assets.

List purge requests

GET
https://api.scaleway.com
/edge-services/v1beta1/purge-requests

List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List purge requests › query Parameters

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

organization_id
​string

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

project_id
​string

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

pipeline_id
​string

Pipeline ID to filter for. Only purge requests from this pipeline will be returned.

List purge requests › Responses

200
scaleway.edge_services.v1beta1.ListPurgeRequestsResponse

Paginated list of purge requests.

total_count
​integer · uint64

Count of all purge requests matching the requested criteria.

Create purge request

POST
https://api.scaleway.com
/edge-services/v1beta1/purge-requests

Create a new purge request. You must specify either the all field (to purge all content) or a list of assets (to define the precise assets to purge).

Create purge request › Request Body

pipeline_id
​string · required

Pipeline ID in which the purge request will be created. (UUID format)

assets
​array | null

List of asserts to purge.

all
​boolean | null

Defines whether to purge all content.

Create purge request › Responses

200
scaleway.edge_services.v1beta1.PurgeRequest
id
​string

ID of the purge request. (UUID format)

pipeline_id
​string

Pipeline ID the purge request belongs to. (UUID format)

Status of the purge request.

Enum values:
unknown_status
done
error
pending
Default: unknown_status
assets
​array | null

List of asserts to purge.

all
​boolean | null

Defines whether to purge all content.

created_at
​string | null · date-time

Date the purge request was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the purge request was last updated. (RFC 3339 format)

Get purge request

GET
https://api.scaleway.com
/edge-services/v1beta1/purge-requests/{purge_request_id}

Retrieve information about a purge request, specified by its purge_request_id. Its full details, including status and target, are returned in the response object.

Get purge request › path Parameters

purge_request_id
​string · required

ID of the requested purge request. (UUID format)

Get purge request › Responses

200
scaleway.edge_services.v1beta1.PurgeRequest
id
​string

ID of the purge request. (UUID format)

pipeline_id
​string

Pipeline ID the purge request belongs to. (UUID format)

Status of the purge request.

Enum values:
unknown_status
done
error
pending
Default: unknown_status
assets
​array | null

List of asserts to purge.

all
​boolean | null

Defines whether to purge all content.

created_at
​string | null · date-time

Date the purge request was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the purge request was last updated. (RFC 3339 format)

Backend stagesOther endpoints