PurgeObjectCaches

1. API Description

This interface is used to refresh file content on the nodes. The refreshed file caches will immediately become invalid, and new requests will fetch the latest files from the origin. It supports batch URL purging.

2. Request Parameters

The following request parameters list only includes the required parameters for the interface.

Parameter NameRequiredTypeDescription

objectType

No

String

objectPaths

Yes

Array of String

Files or directories to be purged.

3. Output Parameters

Parameter NameTypeDescription

requestId

String

Unique request ID, returned with each request. Provide this requestId when locating issues.

taskId

String

Purge task Id

4. Code Example

  1. Cache Purge

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: PurgeObjectCaches
<Common Request Params>

Request:
{
  "objectType": "URL",
  "objectPaths": ["http://cdntest.zenlayer.com/dir/1.jpg", "http://cdntest.zenlayer.com/dir/2.jpg"]
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "taskId": "taskId-xxxxxx"
  }
}

5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see Common Error Codes.

Last updated