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
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.
query Parameters
order_bySort order of purge requests in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of purge requests to return per page.
organization_idOrganization ID to filter for. Only purge requests from this Project will be returned.
project_idProject ID to filter for. Only purge requests from this Project will be returned.
pipeline_idPipeline ID to filter for. Only purge requests from this pipeline will be returned.
List purge requests › Responses
Paginated list of purge requests.
total_countCount of all purge requests matching the requested criteria.
Create purge request
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_idPipeline ID in which the purge request will be created. (UUID format)
assetsList of asserts to purge.
allDefines whether to purge all content.
Create purge request › Responses
idID of the purge request. (UUID format)
pipeline_idPipeline ID the purge request belongs to. (UUID format)
statusStatus of the purge request.
assetsList of asserts to purge.
allDefines whether to purge all content.
created_atDate the purge request was created. (RFC 3339 format)
updated_atDate the purge request was last updated. (RFC 3339 format)
Get purge request
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.
path Parameters
purge_request_idID of the requested purge request. (UUID format)
Get purge request › Responses
idID of the purge request. (UUID format)
pipeline_idPipeline ID the purge request belongs to. (UUID format)
statusStatus of the purge request.
assetsList of asserts to purge.
allDefines whether to purge all content.
created_atDate the purge request was created. (RFC 3339 format)
updated_atDate the purge request was last updated. (RFC 3339 format)