Available in Classic and VPC
Run a purge job.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/purge |
Request headers
For information about the headers common to all Global Edge APIs, see Global Edge request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
edgeId |
Long | Required | Edge ID
|
purgeType |
String | Required | Purge type
|
purgeTarget |
Array | Conditional | Purge target list
|
Note
If the edge's service area is global, the job time varies for each type of purge.
- ALL, DIRECTORY, and PATTERN purge jobs can take about 40 minutes.
- URL-based purge jobs are processed quickly.
Request example
The request example is as follows:
curl --location --request POST 'https://edge.apigw.ntruss.com/api/v1/purge' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"edgeId": 11197,
"purgeType": "DIRECTORY",
"purgeTarget": [
"/src/images/*",
"/static/thumbs/*"
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code |
String | - | Response code |
message |
String | - | Response message |
result |
Array | - | Purge request ID
|
Response status codes
For information about the HTTP status codes common to all Global Edge APIs, see Global Edge response status codes.
Response example
The response example is as follows:
{
"code": "0000",
"message": "Success",
"result": [
372****
]
}