Purge keys from a cache

POST

/api/v3/organizations/{organisation}/resources/{resource}/purge

curl --request POST \
  --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/resources/vk-sessions/purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "environment", "application": "test-app", "environment": "production", "confirm": true, "cursor": "example" }'

• QuantCDN Public Cloud
• QuantGov Cloud

Cache resources only. scope environment deletes that environment’s keys, using the CACHE_PREFIX recorded on its attachment rather than anything in the request. scope all flushes every key for every attached environment and requires confirm=true. A large environment purge may return complete=false with a cursor to resume.

Authorizations

• BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

resource

required

string

The resource ID

Example

vk-sessions

Request Body^required

Media typeapplication/json

object

scope

required

string

Allowed values: environment all

application

Scope environment only

string

Example

test-app

environment

Scope environment only

string

Example

production

confirm

Scope all only; must be true

boolean

cursor

Scope environment only; resume a partial purge

string

Responses

200

Purge result

Media typeapplication/json

object

scope

string

prefix

string

deletedKeys

integer

complete

boolean

cursor

string

flushed

boolean

Example^generated

{
  "scope": "example",
  "prefix": "example",
  "deletedKeys": 1,
  "complete": true,
  "cursor": "example",
  "flushed": true
}

404

No such attachment

422

Invalid scope, missing application/environment, or scope all without confirm