External DocumentationTo learn more, visit the Cloudflare documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Query | The query to use for filtering, searching, and sorting zones, appended directly to the request URL. For example: name.contains=example&status=active&order=name&direction=asc.For more information on what filters you can apply, see the Cloudflare List Zones documentation. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Page | The page number to show results from. Values must be 1 or higher. |
| Per Page | Maximum number of results per page. Value can range from 5 to 50. |
Example Output
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"account": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "Example Account Name"
},
"activated_on": "2014-01-02T00:01:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z",
"development_mode": 7200,
"meta": {
"cdn_only": true,
"custom_certificate_quota": 1,
"dns_only": true,
"foundation_dns": true,
"page_rule_quota": 100,
"phishing_detected": false,
"step": 2
},
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "example.com",
"name_servers": [
"bob.ns.cloudflare.com",
"lola.ns.cloudflare.com"
],
"original_dnshost": "NameCheap",
"original_name_servers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"original_registrar": "GoDaddy",
"owner": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "Example Org",
"type": "organization"
},
"plan": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"can_subscribe": false,
"currency": "USD",
"externally_managed": false,
"frequency": "monthly",
"is_subscribed": false,
"legacy_discount": false,
"legacy_id": "free",
"name": "Example Org",
"price": 10.99
},
"cname_suffix": "cdn.cloudflare.com",
"paused": true,
"permissions": [
"#worker:read"
],
"status": "active",
"tenant": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "Example Account Name"
},
"tenant_unit": {
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"type": "full",
"vanity_name_servers": [
"ns1.example.com",
"ns2.example.com"
],
"verification_key": "284344499-1084221259"
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}