voxel.voxcast.ondemand.content.purge_file

Purge one or more pieces of content 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
paths (required)
A newline-separated list of paths to the content, e.g., "/path/to/content1\n/path/to/content2\n...", with at most 500 paths

Example Response

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

Notes

None

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 600 calls per Minute.
This limit is based on the number of files purged, not the number of hAPI calls.