Skip to main content
POST
Purge edge cache
Required permission: environment.edit

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

environment
string
required

The environment identifier

Body

application/json
path
string | null

A single path to purge, resolved against every hostname the environment is served from.

Maximum string length: 2048
Example:

"/blog/hello-world"

prefix
string | null

A path prefix to purge, resolved against every hostname the environment is served from.

Maximum string length: 2048
Example:

"/blog/"

tag

A Cache-Tag value, or a list of up to 100 values, to purge. Requires the environment to use a dedicated edge network.

Example:

"blog-posts"

Response

EnvironmentResource

data
EnvironmentResource · object
required
included
(ApplicationResource · object | BranchResource · object | DeploymentResource · object | DomainResource · object | InstanceResource · object | DatabaseSchemaResource · object | CacheResource · object | FilesystemResource · object | WebsocketApplicationResource · object | SecretResource · object)[]