Skip to main content
POST
Clear an application's pipeline cache

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id
string<uuid>
required

Body

application/json
path
string
required

The cache's mount path as the cache listing shows it (mount_path). A relative path is read under /workspace.

trust
enum<string> | null

The trust scope to clear: the default branch's caches or every other run's. Null or absent clears both.

Available options:
default_branch,
branch,
null

Response

What the Clear took out; zeros when nothing was left to clear.

archives_cleared
integer
required

Ready archives at the path that will no longer be restored.

Required range: x >= 0
archive_bytes
integer<int64>
required

The size those archives recorded, in bytes.

Required range: x >= 0
volumes_cleared
integer
required

Cache volumes no step will mount again, one per volume however many cache keys named it.

Required range: x >= 0
volumes_deleted_after
string<date-time> | null
required

No cleared volume is deleted before this moment, the Clear plus one day; the cache reaper deletes them on its first sweep after it while the cluster's agent takes commands. Null when no volume was cleared.