Skip to main content

Custom Purge

Invalidate cached assets whose URLs match the specified path prefix or suffix.

Request

Request-Line

POST /waap/v1.0/services/{serviceId}/purges/custom HTTP/1.1

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
serviceIdLongMandatoryService ID.

Body Parameters

ParameterTypeRequiredDescription
operatorStringMandatoryEither startswith or endswith.
patternStringMandatoryPath pattern to match; must start with "/" (e.g. /images/).

Response

Response Body

ParameterTypeRequiredDescription
batchIdLongMandatoryBatch ID.

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400Request.BadRequestBad request.
400ServiceId.InvalidServiceId is empty or invalid.
400Operator.InvalidOperator is empty or invalid.
400Pattern.InvalidPattern is empty or invalid.
404ServiceId.NotFoundServiceId is not found.
400Purge.OperationFailedThe purge operation failed.

Examples

Custom Purge

Request

POST /waap/v1.0/services/67709/purges/custom HTTP/1.1

{
"operator": "startswith",
"pattern": "/test"
}

Successful Response Body

{
"batchId":1234
}