voxel.voxcast.ondemand.content.purge_site

Purge all the content for an entire site from the CDN's cache. Generates an asynchronous transaction that can be checked with voxel.voxcast.ondemand.content.transaction_status.

Parameters

device_id (required)
Numeric Voxel device id, available from voxel.devices.list

Example Response

<transaction>
        <type>purge-site</type>
        <id>b70664f0-d7f4-4dad-9d7a-a6e194b10768</id>
        <expiration>1223022229</expiration>
        <status>inprogress</status>
</transaction>

Notes

The content is purged immediately. This is the preferred method for erasing the entire cache of the site, rather than voxel.voxcast.ondemand.content.purge_file with a list of all objects, or voxel.voxcast.ondemand.content.purge_directory with "/".

Method Specific Error Codes

100: Unknown device
The device_id passed in can't be matched to a valid device.
202: VoxCAST request failed (reason)
An error occurred in attempting the VoxCAST request. A reason may be specified in parenthesis.

Rate Limits

Averaging Rate Limiter (Requests per period)
No more than 2 calls per Minute.