Run purge

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
GET \| POST	/cdn/v2/requestGlobalCdnPurge

Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Global CDN APIs, see Global CDN request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`cdnInstanceNo`	String	Required	CDN instance number See Get instance.
`isWholeDomain`	Boolean	Required	Whether to purge all domains `true` \| `false` `true`: All domains `false`: Specified domains
`isWholePurge`	Boolean	Required	Whether to purge all files `true` \| `false` `true`: All files `false`: Specified files
`serviceDomainNameList.N`	Array	Conditional	Service domain list Required if `isWholeDomain` is `false` Example: `serviceDomainNameList.1=sample.example.com&serviceDomainNameList.2=test.example.com`
`targetFileList.N`	Array	Conditional	Purge target list Required if `isWholePurge` is `false` Example: `targetFileList.1=alice.txt&targetFileList.2=bob.png`
`responseFormatType`	String	Optional	Format of the response data `xml` (default) \| `json`

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/requestGlobalCdnPurge?cdnInstanceNo=2851****&isWholeDomain=true
&isWholePurge=false&targetFileList.1=file.txt&targetFileList.2=compressed.zip&responseFormatType=json' \
--header 'Content-Type: application/json' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`requestGlobalCdnPurgeResponse`	Object	-	Response result
`requestGlobalCdnPurgeResponse.totalRows`	Integer	-	Number of response results
`requestGlobalCdnPurgeResponse.globalCdnPurgeHistoryList`	Array	-	Purge history list
`requestGlobalCdnPurgeResponse.requestId`	String	-	ID for the request UUID format
`requestGlobalCdnPurgeResponse.returnCode`	String	-	Response code
`requestGlobalCdnPurgeResponse.returnMessage`	String	-	Response message

`globalCdnPurgeHistoryList`

The following describes globalCdnPurgeHistoryList.

Field	Type	Required	Description
`cdnInstanceNo`	String	-	CDN instance number
`purgeId`	String	-	Purge request ID
`isWholePurge`	Boolean	-	Whether to purge all files `true` \| `false` `true`: All files `false`: Specified files
`isWholeDomain`	Boolean	-	Whether to purge all domains `true` \| `false` `true`: All domains `false`: Specified domains
`globalCdnServiceDomainList`	Array	-	Service domain list: globalCdnServiceDomainList
`targetFileList`	Array	-	Purge target list
`isSuccess`	Boolean	-	Purge success status `true` \| `false` `true`: Success `false`: Failure

`globalCdnServiceDomainList`

The following describes globalCdnServiceDomainList.

Field	Type	Required	Description
`serviceDomainTypeCode`	String	-	Service domain type `DEFAULT` \| `USER` `DEFAULT`: CDN domain provided by NAVER Cloud Platform `USER`: User-owned domain
`protocolTypeCode`	String	-	Service protocol
`defaultDomainName`	String	-	NAVER Cloud Platform domain name
`userDomainName`	String	-	User domain name

Response status codes

For information about the HTTP status codes common to all Global CDN APIs, see Global CDN response status codes.

Response example

The response example is as follows:

{
    "requestGlobalCdnPurgeResponse": {
        "totalRows": 1,
        "globalCdnPurgeHistoryList": [
            {
                "cdnInstanceNo": "2851****",
                "purgeId": "edup-Cgqm**************uM",
                "isWholePurge": false,
                "isWholeDomain": true,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "wlrw*********.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "targetFileList": [
                    "/file.txt",
                    "/compressed.zip"
                ],
                "isSuccess": true
            }
        ],
        "requestId": "8eb274f2-****-****-****-50e2d1930727",
        "returnCode": "0",
        "returnMessage": "success"
    }
}