- Docs
- API
API
The REST API: authentication, the response envelope, errors and rate limits, then an article for each resource with a request and its response.
- API overviewThe API manages zones, hostnames, certificates, purges and signing keys, reads a zone's statistics and lists the locations, with one key per account. It is JSON over HTTPS at https://api.cachegenie.com/v1.
- ZonesA zone is one origin with its hostnames and its settings. Five calls create, read, update and delete zones, and every setting a zone has is a field on the same object.
- Hostnames and certificatesA zone serves on the hostnames you add to it. Five calls manage the hostnames and three more the certificate on one of them; the hostname object says whether SSL is on, whether HTTP is redirected, and which certificate is in place.
- PurgingPurge a file, a folder, a cache tag or a whole zone through the API, and check when every location has applied it.
- StatisticsOne call returns a zone's traffic as a series of days or hours, plus a breakdown of the period by country and by network.
- Signing keysA zone with token authentication on serves only links signed with its key. The key has an endpoint of its own, so that listing zones never returns a secret: one call reads it and one issues a new one.
- Origin certificatesA zone's origin certificate has an endpoint of its own, like its signing key, so listing zones never returns it: one call reads it, one creates or reissues it and is the only answer that carries its private key, and one revokes it.
- Edge addressesThe addresses a request from us reaches your origin from, for a firewall rule or a security group. They are published on the API with no key needed: as JSON, and as plain text with one address per line.