Requesting purge
- Print
- PDF
Requesting purge
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Request purge.
Requests
Request URL
POST
https://edge.apigw.ntruss.com/api/v1/purge
Request bodies
| Item | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| profileId | Yes | Long | Profile number | |
| edgeId | Yes | Long | Edge number | |
| purgeType | Yes | PurgeType | Purge type | |
| purgeTarget | Conditional | List<String> | Refer to description about PurgeType | Purge target list |
PurgeType
| Value | Description | purgeTarget restrictions | Examples |
|---|---|---|---|
| ALL | Purge all contents | Must be omitted | null |
| DIRECTORY | Purge by directory | Starts with '/' Ends with '/*' | /* /src/* /src/images/* |
| PATTERN | Purge content by extension | Starts with '/' Ends with extension like '*.abc' | /*.jpg /static/*.png /static/images/*.css |
| URL | Purge designated content with URL | Starts with '/' '*' cannot be used | /src/css/main.css?version=20221124 |
Response
Every response returns success or failure with an HTTP status code.
| HTTP status code | Code message | Description |
|---|---|---|
| 200 | Success | Search succeeded |
| 401 | Unauthorized | Authentication failed |
| 500 | Internal Server Error | Server error |
Response body
| Type | Description |
|---|---|
| List<Long> | Purge request number list |
Examples
Request examples
https://edge.apigw.ntruss.com/api/v1/purge
{
"profileId": 111,
"edgeId": 222,
"purgeType": "DIRECTORY",
"purgeTarget": [
"/src/images/*",
"/static/thumbs/*"
]
}
Response examples
{
"code":"0000",
"message":"Success",
"result":[
9999
]
}
Errors
| Error code | Description |
|---|---|
| 0032 | Unauthorized request |
| 0400 | Requested data format mismatch |
| 9999 | Server error occurred |
Was this article helpful?