Status of a project's latest cache clear

GET

/api/v1/projects/{id}/cache/purge

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/projects/example/cache/purge \
  --header 'Authorization: <Authorization>'

The newest Clear cache of the project: queued while any hostname is still waiting to be purged, done once every one was, failed when a purge gave up (it is retried automatically). retry_after_seconds says how long until another Clear cache is allowed (0: now).

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Project ID (UUID)

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

completed_at

CompletedAt is set once every hostname was purged (status done).

string

hosts

Array<string>

id

string

requested_at

string

retry_after_seconds

RetryAfterSeconds is how long until another Clear cache is allowed; 0 when it is now.

integer

status

string

Allowed values: queued done failed

Example

{
  "data": {
    "status": "queued"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

PROJECT_NOT_FOUND, or CACHE_PURGE_NONE when the cache was never cleared

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}