List zones
GET
/api/zones
Returns the zones the authenticated user can access. Use q to search by name or ID, organization to scope the list to one organization, tag to filter by environment tag, and the order[...] parameters to sort. Full zone_settings are included on each item.
Authorizations
ApiToken
Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.
Type
API Key (header: X-API-TOKEN)
or
JWT
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Type
HTTP (bearer)
Parameters
Query Parameters
page
The collection page number
Type
integer
Default
1itemsPerPage
The number of items per page
Type
integer
Default
30Minimum
0Maximum
100organization
Filter by organization ID
Type
integer
q
Search zones by name or ID
Type
string
tag
Filter by environment tag. One of: prod, stage, dev.
Type
string
tag[]
Filter by environment tag. One of: prod, stage, dev.
Type
array
order[name]
Sort by name. Values: asc, desc.
Type
string
Valid values
"asc""desc""ASC""DESC"order[tag]
Sort by tag. Values: asc, desc.
Type
string
Valid values
"asc""desc""ASC""DESC"order[createdAt]
Sort by creation date. Values: asc, desc.
Type
string
Valid values
"asc""desc""ASC""DESC"order[updatedAt]
Sort by last-update date. Values: asc, desc.
Type
string
Valid values
"asc""desc""ASC""DESC"Responses
Zone collection
JSON "totalItems": 0, "search": { "@type": "string", "template": "string", "variableRepresentation": "string", "mapping": [ { "@type": "string", "variable": "string", "property": "string", "required": true } ] }, "view": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" }, "member": [ { "@context": "string", "@id": "string", "@type": "string", "id": 42, "organization": "/api/organizations/1", "name": "my-website", "tag": "prod", "banToken": "smoxy_ban_3f8c1a2b4d5e6f70819a2b3c4d5e6f708192a3b4c5d6e7f809a1b2c3d4e5f607", "createdAt": "2026-01-15T09:30:00+00:00", "updatedAt": "2026-01-20T14:05:00+00:00", "rewriteRules": [ "https://example.com/" ], "configurationRules": [ "https://example.com/" ], "accessRules": [ "https://example.com/" ], "securityScenarios": [ "https://example.com/" ], "enabled": true, "hasRedirects": false, "defaultBackend": { "type": "string", "id": "string" }, "cachingDynamicEnabled": false, "cachingRespectCacheControl": true, "cachingDynamicCacheKey": { "varyByHostname": true, "varyByCookie": [ ], "varyByCountry": true, "varyByHeader": [ ] }, "cachingStaticEnabled": false, "cachingStaticCacheKey": { "varyByHostname": true, "varyByQueryString": [ ] }, "cachingDefaultTtl": 604800, "cachingIgnoredUrlParams": [ ], "cachingManagedIgnoredUrlParamsEnabled": true, "cachingIgnoredCacheTags": [ ], "cachingCustomCacheTagHeaders": [ { "header": "string", "delimiter": "string" } ], "headersResponseRemove": [ ], "debugHeadersEnabled": false, "serverTimingEnabled": false, "stripCacheTagHeaders": false, "processingSsi": false, "processingEsi": false, "compressionCodecs": [ [ "zstd" ] ], "underAttack": false, "customPagesErrorEnabled": false, "customPagesMaintenanceActive": false, "customPagesSecurityEnabled": false, "customPagesChallengeEnabled": false, "basicAuthEnabled": false, "basicAuthUsers": [ { "@context": "string", "@id": "string", "@type": "string", "id": "9f8b2c1a-4d3e-4f5a-8b6c-7d8e9f0a1b2c", "username": "jdoe" } ], "securityEnabled": true, "imageOptimizationEnabled": true, "imageOptimizationWebpEnabled": true, "imageOptimizationAvifEnabled": true, "imageOptimizationAvifQuality": 50, "imageOptimizationWebpQuality": 50, "imageOptimizationJpegQualityTarget": 0.9997, "imageOptimizationJpegEnabled": false, "imageOptimizationJpegQualityMin": 40, "imageOptimizationJpegQualityMax": 98, "imageOptimizationPngEnabled": false, "imageOptimizationPngQualityMin": 40, "imageOptimizationPngQualityMax": 98, "minifyHtml": false, "staleCacheWhileOffline": false, "staleCacheWhileUpdating": false, "cacheErrorResponse": false, "cacheControlPublicMaxAgeOverride": 3600, "maxRules": 30, "maxWafRules": 3, "maxScenarios": 3, "logForwardingEnabled": false, "logForwardingHostname": "logs.example.com", "logForwardingPort": 514, "logForwardingToken": "abc123def456", "logForwardingProtocol": "tcp", "logForwardingFormat": "json", "createdBy": "/api/organizations/1/members/5", "headersRequestSet": [ { "name": "string", "value": "string" } ], "headersResponseSet": [ { "name": "string", "value": "string" } ], "headersResponseAdd": [ { "name": "string", "value": "string" } ], "rulesUsed": 5, "wafRulesUsed": 1, "scenariosUsed": 2 } ]
{
}