--- title: List Zones --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zones](https://developers.cloudflare.com/api/python/resources/zones) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Zones zones.list(ZoneListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Zone]()] GET/zones Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Zone Zone Read` ##### ParametersExpand Collapse
account: Optional\[Account] id: Optional\[str] Filter by an account ID. Link to this property name: Optional\[str] An account Name. Optional filter operators can be provided to extend refine the search: - equal (default) - not_equal - starts_with - ends_with - contains - starts_with_case_sensitive - ends_with_case_sensitive - contains_case_sensitive maxLength253 Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account%20%3E%20(schema)>)
direction: Optional\[Literal\["asc", "desc"]] Direction to order zones. One of the following: "asc" Link to this property "desc" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>)
match: Optional\[Literal\["any", "all"]] Whether to match all search requirements or at least one (any). One of the following: "any" Link to this property "all" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20match%20%3E%20(schema)>) name: Optional\[str] A domain name. Optional filter operators can be provided to extend refine the search: - `equal` (default) - `not_equal` - `starts_with` - `ends_with` - `contains` - `starts_with_case_sensitive` - `ends_with_case_sensitive` - `contains_case_sensitive` maxLength253 [Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)
order: Optional\[Literal\["name", "status", "account.id", 2 more]] Field to order zones by. One of the following: "name" Link to this property "status" Link to this property "account.id" Link to this property "account.name" Link to this property "plan.id" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order%20%3E%20(schema)>) page: Optional\[float] Page number of paginated results. minimum1 [Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: Optional\[float] Number of zones per page. maximum50 minimum5 [Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
status: Optional\[Literal\["initializing", "pending", "active", "moved"]] Specify a zone status to filter by. One of the following: "initializing" Link to this property "pending" Link to this property "active" Link to this property "moved" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20status%20%3E%20(schema)>)
type: Optional\[List\[Literal\["full", "partial", "secondary", "internal"]]] Zone types to filter by. Multiple types can be specified as a comma-separated list (e.g., ?type=full,partial,secondary). When this parameter is not provided, zones with type “internal” are excluded from the results. One of the following: "full" Link to this property "partial" Link to this property "secondary" Link to this property "internal" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20type%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Zone: … id: str Identifier maxLength32 Link to this property
account: Account The account the zone belongs to. id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] The name of the account. Link to this property
Link to this property activated\_on: Optional\[datetime] The last time proof of ownership was detected and the zone was made active. formatdate-time Link to this property created\_on: datetime When the zone was created. formatdate-time Link to this property development\_mode: float The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is 0. Link to this property
meta: Meta Metadata about the zone. cdn\_only: Optional\[bool] The zone is only configured for CDN. Link to this property custom\_certificate\_quota: Optional\[int] Number of Custom Certificates the zone can have. Link to this property dns\_only: Optional\[bool] The zone is only configured for DNS. Link to this property foundation\_dns: Optional\[bool] The zone is setup with Foundation DNS. Link to this property page\_rule\_quota: Optional\[int] Number of Page Rules a zone can have. Link to this property phishing\_detected: Optional\[bool] The zone has been flagged for phishing. Link to this property step: Optional\[int] Link to this property
Link to this property modified\_on: datetime When the zone was last modified. formatdate-time Link to this property name: str The domain name. Per RFC 1035 the overall zone name can be up to 253 characters, with each segment (“label”) not exceeding 63 characters. maxLength253 Link to this property name\_servers: List\[str] The name servers Cloudflare assigns to a zone. Link to this property original\_dnshost: Optional\[str] DNS host at the time of switching to Cloudflare. maxLength50 Link to this property original\_name\_servers: Optional\[List\[str]] Original name servers before moving to Cloudflare. Link to this property original\_registrar: Optional\[str] Registrar for the domain at the time of switching to Cloudflare. Link to this property
owner: Owner The owner of the zone. id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] Name of the owner. Link to this property type: Optional\[str] The type of owner. Link to this property
Link to this property
Deprecatedplan: Plan Please use the /zones/{zone_id}/subscription API to update a zone’s plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. A Zones subscription information. id: Optional\[str] Identifier maxLength32 Link to this property can\_subscribe: Optional\[bool] States if the subscription can be activated. Link to this property currency: Optional\[str] The denomination of the customer. Link to this property externally\_managed: Optional\[bool] If this Zone is managed by another company. Link to this property frequency: Optional\[str] How often the customer is billed. Link to this property is\_subscribed: Optional\[bool] States if the subscription active. Link to this property legacy\_discount: Optional\[bool] If the legacy discount applies to this Zone. Link to this property legacy\_id: Optional\[str] The legacy name of the plan. Link to this property name: Optional\[str] Name of the owner. Link to this property price: Optional\[float] How much the customer is paying. Link to this property
Link to this property cname\_suffix: Optional\[str] Allows the customer to use a custom apex. *Tenants Only Configuration*. Link to this property paused: Optional\[bool] Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. Link to this property Deprecatedpermissions: Optional\[List\[str]] This has been replaced by Account memberships. Legacy permissions based on legacy user membership information. Link to this property
status: Optional\[Literal\["initializing", "pending", "active", "moved"]] The zone status on Cloudflare. One of the following: "initializing" Link to this property "pending" Link to this property "active" Link to this property "moved" Link to this property
Link to this property
tenant: Optional\[Tenant] The root organizational unit that this zone belongs to (such as a tenant or organization). id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] The name of the Tenant account. Link to this property
Link to this property
tenant\_unit: Optional\[TenantUnit] The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization). id: Optional\[str] Identifier maxLength32 Link to this property
Link to this property
type: Optional\[Type] A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. One of the following: "full" Link to this property "partial" Link to this property "secondary" Link to this property "internal" Link to this property
Link to this property vanity\_name\_servers: Optional\[List\[str]] An array of domains used for custom name servers. This is only available for Business and Enterprise plans. Link to this property verification\_key: Optional\[str] Verification key for partial zone setup. Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(model)%20zone%20%3E%20(schema)>) ### List Zones Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.zones.list() page = page.result[0] print(page.id) ``` 200 example ``` { "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 } } ``` ##### Returns Examples 200 example ``` { "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 } } ```