omegazero API documentation


Prefetches a resource from the backend, causing all active CDN servers to cache the resource.

URL Parameters

Name Type Description Required Default value
host string The hostname, usually a domain name. yes -
path string The path of the resource, for example /index.html. yes -


This endpoint requires a domain key to prefetch a resource for a particular domain, which must be sent as the value in a x-domain-auth header. This key is available in the Hosting Management Interface for a domain you host at "Internet Resources" -> "Domains (ICANN)" -> [your domain name] -> "Manage" -> "Domain Key" -> "Show Domain Key".

Response Body

JSON Object where the keys are the full names of the CDN servers and the value is another JSON object each containing status information about the prefetch of the particular CDN server, which have the following format:

Name Type Description
status string The prefetch status. See below.
server string The cache server name.
httpStatus number The HTTP status received by the server while prefetching.

Prefetch statuses


Rate Limit: 5 requests per 5s