Get purge request
- Print
- PDF
Get purge request
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Get details about a purge job request.
Request
Request URL
GET
https://edge.apigw.ntruss.com/api/v1/purge/{purgeRequestId}
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| purgeRequestId | Yes | Long | Purge request number |
Response
All responses return success or failure as an HTTP status code.
| HTTP status code | Code message | Description |
|---|---|---|
| 200 | Success | Search succeeded |
| 401 | Unauthorized | Authentication failed |
| 500 | Internal Server Error | Server Error |
PurgeHistory
| Category | Type | Description |
|---|---|---|
| clientIp | String | Purge requester IP |
| purgeId | Long | Purge request number |
| instanceNo | Long | Edge contract number |
| requestDateTime | ZonedDateTime | Purge request date and time (UTC) |
| serviceDomain | String | Purge target domain |
| status | PurgeResult | Purge progress |
| targetDirectory | String | List of purge target directories (comma-serialized) |
| targetFileList | List<String> | Purge target list |
| targetFileListString | String | List of purge targets (comma-serialized) |
| purgeType | PurgeType | Purge type |
| workerType | WorkerType | Purge requester account type |
| ticketId | String | Purge ticket ID |
PurgeResult
| Value | Description |
|---|---|
| READY | Purge pending execution |
| RUNNING | Purge running |
| SUCCESS | Completed |
| FAILURE | Purge failed |
PurgeType
| Value | Description |
|---|---|
| ALL | Purge all content |
| DIRECTORY | Per-directory purge |
| PATTERN | Purge content by extension |
| URL | Purge content specified by URL |
WorkerType
| Value | Description |
|---|---|
| ACCOUNT | Requested with main account |
| SUBACCOUNT | Requested from a sub account |
Examples
Request example
https://edge.apigw.ntruss.com/api/v1/purge/9999
Response example
{
"clientIp":"127.0.0.1",
"purgeId":9999,
"instanceNo":999999,
"requestDateTime":"2022-11-24T07:54:13Z",
"serviceDomain":"sample.mycustomdomain.com",
"status":"READY",
"purgeType":"ALL",
"workerType":"ACCOUNT",
"ticketId":"PT-00000000000000000000"
}
Errors
| Error code | Description |
|---|---|
| 0032 | Unauthorized request |
| 0400 | Request data format mismatch |
| 9999 | Server error occurred |
Was this article helpful?