Version 2.1.1792967583 · latest Download OpenAPI Markdown

Purge and prefetch

Purge cached URLs or directories, and prefetch given URLs.

cache-jobsCacheAuthentication: User (some parameters admin only)3 endpoints

List purge/prefetch jobs

GET/api/v2/cache-jobs

Authentication: User (some parameters admin only)

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data
type	string	—	Only list jobs of this type. Values `["purge_url","purge_dir","prefetch"]`
url	string	—	If it starts with http:// or https://, exact match on the full URL, normalized as on submission (the job's URL list contains it); otherwise exact match on the host name.

POST/api/v2/cache-jobs

Authentication: User (some parameters admin only)

Field	Type	Required	Description
type	string	Required	purge_url = purge URLs; purge_dir = purge directories (URL ends with /); prefetch = prefetch. Values `["purge_url","purge_dir","prefetch"]`
urls	string[]	Required	http(s)://host/path (normalized, see create); at most 100 entries per prefetch.

GET/api/v2/cache-jobs/{id}

Authentication: User (some parameters admin only)

Field	Type	Required	Description
created_at	string	—	Created at read-only
id	integer	—	Record ID read-only
results	CacheJobNodeResult[]	—	Execution result of each node (returned in details only). read-only
site_id	integer	—	Site ID read-only
status	string	—	Status of the push task (if some nodes fail it stays pending and retries with backoff, then becomes failed when retries run out). read-onlyValues `["pending","running","done","failed"]`
tenant_id	integer	—	Owner tenant (user) ID read-only
type	string	—	purge_url = purge URLs; purge_dir = purge directories (URL ends with /); prefetch = prefetch. Values `["purge_url","purge_dir","prefetch"]`
updated_at	string	—	Updated at read-only
urls	string[]	—	http(s)://host/path (normalized, see create); at most 100 entries per prefetch.