Clear the domain's cached pointer and snapshot on every origin replica. There is no shared HTTP cache, so this is only an escape hatch for a suspected stale in-process cache; publishing never needs it. Rate-limited.
Input
Encoding
application/jsondomain
string
Required
The registered hostname.
maxLength: 253 bytespaths
array
Optional
Accepted but ignored. A purge always covers the whole domain.
Output
Encoding
application/jsonpurged
boolean
Required
No description available.
Errors
DomainNotFound
No registration for that domain belongs to the caller. RateLimitExceeded
Too many purge requests. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"domain"
],
"properties": {
"paths": {
"type": "array",
"items": {
"type": "string"
},
"description": "Accepted but ignored. A purge always covers the whole domain."
},
"domain": {
"type": "string",
"maxLength": 253,
"description": "The registered hostname."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "DomainNotFound",
"description": "No registration for that domain belongs to the caller."
},
{
"name": "RateLimitExceeded",
"description": "Too many purge requests."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"purged"
],
"properties": {
"purged": {
"type": "boolean"
}
}
},
"encoding": "application/json"
},
"description": "Clear the domain's cached pointer and snapshot on every origin replica. There is no shared HTTP cache, so this is only an escape hatch for a suspected stale in-process cache; publishing never needs it. Rate-limited."
}