Edge API Reference
Programmatic access to zones, cache purging, origin configuration and real-time traffic analytics. All requests are made over HTTPS and authenticated with a bearer token issued in the dashboard.
Edge locations
214
API uptime (30d)
99.98%▲ 0.01
Median purge time
148 ms
p95 API latency
62 ms
List zones
GET/v1/zones
Returns a paginated list of zones available to the authenticated account, ordered by creation date.
| Query param | Type | Description |
|---|---|---|
page | integer | Page number, default 1 |
per_page | integer | Items per page, max 100 |
status | string | active | pending | paused |
Response200 OK
Create zone
POST/v1/zones
Registers a new hostname on the edge network. DNS validation must be completed before the zone becomes
active.| Body field | Type | Description |
|---|---|---|
namerequired | string | Fully-qualified hostname |
originrequired | string | Origin URL or IP |
plan | string | free | pro | business |
Response201 Created
Purge cache
POST/v1/zones/{zone_id}/purge
Invalidates cached objects across all edge locations. Purge is asynchronous; poll the returned task to track propagation.
| Body field | Type | Description |
|---|---|---|
files | string[] | Up to 500 absolute URLs |
tags | string[] | Cache-Tag values |
purge_everything | boolean | Purge entire zone |
Response202 Accepted
Get purge status
GET/v1/purge/{task_id}
Returns the propagation state of a purge task. Status transitions:
queued → in_progress → completed.Response200 OK
Update origin
PUT/v1/zones/{zone_id}/origin
Replaces the origin configuration for the zone, including failover and host header override.
| Body field | Type | Description |
|---|---|---|
primaryrequired | string | Primary origin URL |
fallback | string | Failover origin |
host_header | string | Override Host header |
Response200 OK
Zone analytics
GET/v1/zones/{zone_id}/stats
Aggregated traffic metrics for a time range. Data granularity depends on the requested window.
| Query param | Type | Description |
|---|---|---|
since | ISO 8601 | Start of range |
until | ISO 8601 | End of range |
Response200 OK
Delete certificate
DELETE/v1/certs/{cert_id}
Removes a custom TLS certificate. Zones using it will fall back to the managed certificate.
Response204 No Content
// empty body
API console
Send a test request. Requests without a valid token will be rejected.
// response will appear here