# Zones ## 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. ### Parameters - `account: Optional[Account]` - `id: Optional[str]` Filter by an account ID. - `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` - `direction: Optional[Literal["asc", "desc"]]` Direction to order zones. - `"asc"` - `"desc"` - `match: Optional[Literal["any", "all"]]` Whether to match all search requirements or at least one (any). - `"any"` - `"all"` - `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` - `order: Optional[Literal["name", "status", "account.id", 2 more]]` Field to order zones by. - `"name"` - `"status"` - `"account.id"` - `"account.name"` - `"plan.id"` - `page: Optional[float]` Page number of paginated results. - `per_page: Optional[float]` Number of zones per page. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` Specify a zone status to filter by. - `"initializing"` - `"pending"` - `"active"` - `"moved"` ### Returns - `class Zone: …` - `id: str` Identifier - `account: Account` The account the zone belongs to. - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the account. - `activated_on: Optional[datetime]` The last time proof of ownership was detected and the zone was made active. - `created_on: datetime` When the zone was created. - `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. - `meta: Meta` Metadata about the zone. - `cdn_only: Optional[bool]` The zone is only configured for CDN. - `custom_certificate_quota: Optional[int]` Number of Custom Certificates the zone can have. - `dns_only: Optional[bool]` The zone is only configured for DNS. - `foundation_dns: Optional[bool]` The zone is setup with Foundation DNS. - `page_rule_quota: Optional[int]` Number of Page Rules a zone can have. - `phishing_detected: Optional[bool]` The zone has been flagged for phishing. - `step: Optional[int]` - `modified_on: datetime` When the zone was last modified. - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `name_servers: List[str]` The name servers Cloudflare assigns to a zone. - `original_dnshost: Optional[str]` DNS host at the time of switching to Cloudflare. - `original_name_servers: Optional[List[str]]` Original name servers before moving to Cloudflare. - `original_registrar: Optional[str]` Registrar for the domain at the time of switching to Cloudflare. - `owner: Owner` The owner of the zone. - `id: Optional[str]` Identifier - `name: Optional[str]` Name of the owner. - `type: Optional[str]` The type of owner. - `plan: Plan` A Zones subscription information. - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` States if the subscription can be activated. - `currency: Optional[str]` The denomination of the customer. - `externally_managed: Optional[bool]` If this Zone is managed by another company. - `frequency: Optional[str]` How often the customer is billed. - `is_subscribed: Optional[bool]` States if the subscription active. - `legacy_discount: Optional[bool]` If the legacy discount applies to this Zone. - `legacy_id: Optional[str]` The legacy name of the plan. - `name: Optional[str]` Name of the owner. - `price: Optional[float]` How much the customer is paying. - `cname_suffix: Optional[str]` Allows the customer to use a custom apex. *Tenants Only Configuration*. - `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. - `permissions: Optional[List[str]]` Legacy permissions based on legacy user membership information. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` The zone status on Cloudflare. - `"initializing"` - `"pending"` - `"active"` - `"moved"` - `tenant: Optional[Tenant]` The root organizational unit that this zone belongs to (such as a tenant or organization). - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the Tenant account. - `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 - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[List[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. - `verification_key: Optional[str]` Verification key for partial zone setup. ### Example ```python 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) ``` #### Response ```json { "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 } } ``` ## Zone Details `zones.get(ZoneGetParams**kwargs) -> Zone` **get** `/zones/{zone_id}` Zone Details ### Parameters - `zone_id: str` Identifier ### Returns - `class Zone: …` - `id: str` Identifier - `account: Account` The account the zone belongs to. - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the account. - `activated_on: Optional[datetime]` The last time proof of ownership was detected and the zone was made active. - `created_on: datetime` When the zone was created. - `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. - `meta: Meta` Metadata about the zone. - `cdn_only: Optional[bool]` The zone is only configured for CDN. - `custom_certificate_quota: Optional[int]` Number of Custom Certificates the zone can have. - `dns_only: Optional[bool]` The zone is only configured for DNS. - `foundation_dns: Optional[bool]` The zone is setup with Foundation DNS. - `page_rule_quota: Optional[int]` Number of Page Rules a zone can have. - `phishing_detected: Optional[bool]` The zone has been flagged for phishing. - `step: Optional[int]` - `modified_on: datetime` When the zone was last modified. - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `name_servers: List[str]` The name servers Cloudflare assigns to a zone. - `original_dnshost: Optional[str]` DNS host at the time of switching to Cloudflare. - `original_name_servers: Optional[List[str]]` Original name servers before moving to Cloudflare. - `original_registrar: Optional[str]` Registrar for the domain at the time of switching to Cloudflare. - `owner: Owner` The owner of the zone. - `id: Optional[str]` Identifier - `name: Optional[str]` Name of the owner. - `type: Optional[str]` The type of owner. - `plan: Plan` A Zones subscription information. - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` States if the subscription can be activated. - `currency: Optional[str]` The denomination of the customer. - `externally_managed: Optional[bool]` If this Zone is managed by another company. - `frequency: Optional[str]` How often the customer is billed. - `is_subscribed: Optional[bool]` States if the subscription active. - `legacy_discount: Optional[bool]` If the legacy discount applies to this Zone. - `legacy_id: Optional[str]` The legacy name of the plan. - `name: Optional[str]` Name of the owner. - `price: Optional[float]` How much the customer is paying. - `cname_suffix: Optional[str]` Allows the customer to use a custom apex. *Tenants Only Configuration*. - `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. - `permissions: Optional[List[str]]` Legacy permissions based on legacy user membership information. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` The zone status on Cloudflare. - `"initializing"` - `"pending"` - `"active"` - `"moved"` - `tenant: Optional[Tenant]` The root organizational unit that this zone belongs to (such as a tenant or organization). - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the Tenant account. - `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 - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[List[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. - `verification_key: Optional[str]` Verification key for partial zone setup. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone = client.zones.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone.id) ``` #### Response ```json { "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" } } ``` ## Create Zone `zones.create(ZoneCreateParams**kwargs) -> Zone` **post** `/zones` Create Zone ### Parameters - `account: Account` - `id: Optional[str]` Identifier - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` ### Returns - `class Zone: …` - `id: str` Identifier - `account: Account` The account the zone belongs to. - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the account. - `activated_on: Optional[datetime]` The last time proof of ownership was detected and the zone was made active. - `created_on: datetime` When the zone was created. - `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. - `meta: Meta` Metadata about the zone. - `cdn_only: Optional[bool]` The zone is only configured for CDN. - `custom_certificate_quota: Optional[int]` Number of Custom Certificates the zone can have. - `dns_only: Optional[bool]` The zone is only configured for DNS. - `foundation_dns: Optional[bool]` The zone is setup with Foundation DNS. - `page_rule_quota: Optional[int]` Number of Page Rules a zone can have. - `phishing_detected: Optional[bool]` The zone has been flagged for phishing. - `step: Optional[int]` - `modified_on: datetime` When the zone was last modified. - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `name_servers: List[str]` The name servers Cloudflare assigns to a zone. - `original_dnshost: Optional[str]` DNS host at the time of switching to Cloudflare. - `original_name_servers: Optional[List[str]]` Original name servers before moving to Cloudflare. - `original_registrar: Optional[str]` Registrar for the domain at the time of switching to Cloudflare. - `owner: Owner` The owner of the zone. - `id: Optional[str]` Identifier - `name: Optional[str]` Name of the owner. - `type: Optional[str]` The type of owner. - `plan: Plan` A Zones subscription information. - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` States if the subscription can be activated. - `currency: Optional[str]` The denomination of the customer. - `externally_managed: Optional[bool]` If this Zone is managed by another company. - `frequency: Optional[str]` How often the customer is billed. - `is_subscribed: Optional[bool]` States if the subscription active. - `legacy_discount: Optional[bool]` If the legacy discount applies to this Zone. - `legacy_id: Optional[str]` The legacy name of the plan. - `name: Optional[str]` Name of the owner. - `price: Optional[float]` How much the customer is paying. - `cname_suffix: Optional[str]` Allows the customer to use a custom apex. *Tenants Only Configuration*. - `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. - `permissions: Optional[List[str]]` Legacy permissions based on legacy user membership information. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` The zone status on Cloudflare. - `"initializing"` - `"pending"` - `"active"` - `"moved"` - `tenant: Optional[Tenant]` The root organizational unit that this zone belongs to (such as a tenant or organization). - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the Tenant account. - `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 - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[List[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. - `verification_key: Optional[str]` Verification key for partial zone setup. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone = client.zones.create( account={}, name="example.com", ) print(zone.id) ``` #### Response ```json { "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" } } ``` ## Edit Zone `zones.edit(ZoneEditParams**kwargs) -> Zone` **patch** `/zones/{zone_id}` Edits a zone. Only one zone property can be changed at a time. ### Parameters - `zone_id: str` Identifier - `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. - `type: Optional[Literal["full", "partial", "secondary", "internal"]]` A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[SequenceNotStr[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. ### Returns - `class Zone: …` - `id: str` Identifier - `account: Account` The account the zone belongs to. - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the account. - `activated_on: Optional[datetime]` The last time proof of ownership was detected and the zone was made active. - `created_on: datetime` When the zone was created. - `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. - `meta: Meta` Metadata about the zone. - `cdn_only: Optional[bool]` The zone is only configured for CDN. - `custom_certificate_quota: Optional[int]` Number of Custom Certificates the zone can have. - `dns_only: Optional[bool]` The zone is only configured for DNS. - `foundation_dns: Optional[bool]` The zone is setup with Foundation DNS. - `page_rule_quota: Optional[int]` Number of Page Rules a zone can have. - `phishing_detected: Optional[bool]` The zone has been flagged for phishing. - `step: Optional[int]` - `modified_on: datetime` When the zone was last modified. - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `name_servers: List[str]` The name servers Cloudflare assigns to a zone. - `original_dnshost: Optional[str]` DNS host at the time of switching to Cloudflare. - `original_name_servers: Optional[List[str]]` Original name servers before moving to Cloudflare. - `original_registrar: Optional[str]` Registrar for the domain at the time of switching to Cloudflare. - `owner: Owner` The owner of the zone. - `id: Optional[str]` Identifier - `name: Optional[str]` Name of the owner. - `type: Optional[str]` The type of owner. - `plan: Plan` A Zones subscription information. - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` States if the subscription can be activated. - `currency: Optional[str]` The denomination of the customer. - `externally_managed: Optional[bool]` If this Zone is managed by another company. - `frequency: Optional[str]` How often the customer is billed. - `is_subscribed: Optional[bool]` States if the subscription active. - `legacy_discount: Optional[bool]` If the legacy discount applies to this Zone. - `legacy_id: Optional[str]` The legacy name of the plan. - `name: Optional[str]` Name of the owner. - `price: Optional[float]` How much the customer is paying. - `cname_suffix: Optional[str]` Allows the customer to use a custom apex. *Tenants Only Configuration*. - `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. - `permissions: Optional[List[str]]` Legacy permissions based on legacy user membership information. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` The zone status on Cloudflare. - `"initializing"` - `"pending"` - `"active"` - `"moved"` - `tenant: Optional[Tenant]` The root organizational unit that this zone belongs to (such as a tenant or organization). - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the Tenant account. - `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 - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[List[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. - `verification_key: Optional[str]` Verification key for partial zone setup. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone = client.zones.edit( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone.id) ``` #### Response ```json { "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" } } ``` ## Delete Zone `zones.delete(ZoneDeleteParams**kwargs) -> ZoneDeleteResponse` **delete** `/zones/{zone_id}` Deletes an existing zone. ### Parameters - `zone_id: str` Identifier ### Returns - `class ZoneDeleteResponse: …` - `id: str` Identifier ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone = client.zones.delete( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone.id) ``` #### Response ```json { "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" } } ``` ## Domain Types ### Type - `Literal["full", "partial", "secondary", "internal"]` A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. - `"full"` - `"partial"` - `"secondary"` - `"internal"` ### Zone - `class Zone: …` - `id: str` Identifier - `account: Account` The account the zone belongs to. - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the account. - `activated_on: Optional[datetime]` The last time proof of ownership was detected and the zone was made active. - `created_on: datetime` When the zone was created. - `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. - `meta: Meta` Metadata about the zone. - `cdn_only: Optional[bool]` The zone is only configured for CDN. - `custom_certificate_quota: Optional[int]` Number of Custom Certificates the zone can have. - `dns_only: Optional[bool]` The zone is only configured for DNS. - `foundation_dns: Optional[bool]` The zone is setup with Foundation DNS. - `page_rule_quota: Optional[int]` Number of Page Rules a zone can have. - `phishing_detected: Optional[bool]` The zone has been flagged for phishing. - `step: Optional[int]` - `modified_on: datetime` When the zone was last modified. - `name: str` The domain name. Per [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the overall zone name can be up to 253 characters, with each segment ("label") not exceeding 63 characters. - `name_servers: List[str]` The name servers Cloudflare assigns to a zone. - `original_dnshost: Optional[str]` DNS host at the time of switching to Cloudflare. - `original_name_servers: Optional[List[str]]` Original name servers before moving to Cloudflare. - `original_registrar: Optional[str]` Registrar for the domain at the time of switching to Cloudflare. - `owner: Owner` The owner of the zone. - `id: Optional[str]` Identifier - `name: Optional[str]` Name of the owner. - `type: Optional[str]` The type of owner. - `plan: Plan` A Zones subscription information. - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` States if the subscription can be activated. - `currency: Optional[str]` The denomination of the customer. - `externally_managed: Optional[bool]` If this Zone is managed by another company. - `frequency: Optional[str]` How often the customer is billed. - `is_subscribed: Optional[bool]` States if the subscription active. - `legacy_discount: Optional[bool]` If the legacy discount applies to this Zone. - `legacy_id: Optional[str]` The legacy name of the plan. - `name: Optional[str]` Name of the owner. - `price: Optional[float]` How much the customer is paying. - `cname_suffix: Optional[str]` Allows the customer to use a custom apex. *Tenants Only Configuration*. - `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. - `permissions: Optional[List[str]]` Legacy permissions based on legacy user membership information. - `status: Optional[Literal["initializing", "pending", "active", "moved"]]` The zone status on Cloudflare. - `"initializing"` - `"pending"` - `"active"` - `"moved"` - `tenant: Optional[Tenant]` The root organizational unit that this zone belongs to (such as a tenant or organization). - `id: Optional[str]` Identifier - `name: Optional[str]` The name of the Tenant account. - `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 - `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. - `"full"` - `"partial"` - `"secondary"` - `"internal"` - `vanity_name_servers: Optional[List[str]]` An array of domains used for custom name servers. This is only available for Business and Enterprise plans. - `verification_key: Optional[str]` Verification key for partial zone setup. ### Zone Delete Response - `class ZoneDeleteResponse: …` - `id: str` Identifier # Activation Check ## Rerun the Activation Check `zones.activation_check.trigger(ActivationCheckTriggerParams**kwargs) -> ActivationCheckTriggerResponse` **put** `/zones/{zone_id}/activation_check` Triggeres a new activation check for a PENDING Zone. This can be triggered every 5 min for paygo/ent customers, every hour for FREE Zones. ### Parameters - `zone_id: str` Identifier. ### Returns - `class ActivationCheckTriggerResponse: …` - `id: Optional[str]` Identifier. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.zones.activation_check.trigger( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response.id) ``` #### Response ```json { "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" } } ``` ## Domain Types ### Activation Check Trigger Response - `class ActivationCheckTriggerResponse: …` - `id: Optional[str]` Identifier. # Settings ## Get zone setting `zones.settings.get(strsetting_id, SettingGetParams**kwargs) -> SettingGetResponse` **get** `/zones/{zone_id}/settings/{setting_id}` Fetch a single zone setting by name ### Parameters - `zone_id: str` Identifier - `setting_id: str` Setting name ### Returns - `SettingGetResponse` 0-RTT session resumption enabled for this zone. - `class ZeroRTT: …` 0-RTT session resumption enabled for this zone. - `id: Literal["0rtt"]` ID of the zone setting. - `"0rtt"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class AdvancedDDoS: …` Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - `id: Literal["advanced_ddos"]` ID of the zone setting. - `"advanced_ddos"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesAegis: …` Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. - `id: Literal["aegis"]` ID of the zone setting. - `"aegis"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[ZonesCacheRulesAegisValue]` Value of the zone setting. - `enabled: Optional[bool]` Whether the feature is enabled or not. - `pool_id: Optional[str]` Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. - `class AlwaysOnline: …` When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. - `id: Literal["always_online"]` ID of the zone setting. - `"always_online"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAlwaysUseHTTPS: …` Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. - `id: Literal["always_use_https"]` ID of the zone setting. - `"always_use_https"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticHTTPSRewrites: …` Enable the Automatic HTTPS Rewrites feature for this zone. - `id: Literal["automatic_https_rewrites"]` ID of the zone setting. - `"automatic_https_rewrites"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Brotli: …` When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. - `id: Literal["brotli"]` ID of the zone setting. - `"brotli"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCacheTTL: …` Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). - `id: Literal["browser_cache_ttl"]` ID of the zone setting. - `"browser_cache_ttl"` - `value: int` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCheck: …` Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). - `id: Literal["browser_check"]` ID of the zone setting. - `"browser_check"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasCacheLevel: …` Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). - `id: Literal["cache_level"]` ID of the zone setting. - `"cache_level"` - `value: Literal["aggressive", "basic", "simplified"]` Current value of the zone setting. - `"aggressive"` - `"basic"` - `"simplified"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ChallengeTTL: …` Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). - `id: Literal["challenge_ttl"]` ID of the zone setting. - `"challenge_ttl"` - `value: Literal[300, 900, 1800, 11 more]` Current value of the zone setting. - `300` - `900` - `1800` - `2700` - `3600` - `7200` - `10800` - `14400` - `28800` - `57600` - `86400` - `604800` - `2592000` - `31536000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesChinaNetworkEnabled: …` Determines whether or not the china network is enabled. - `id: Literal["china_network_enabled"]` ID of the zone setting. - `"china_network_enabled"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesContentConverter: …` When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the [developer documentation](https://developers.cloudflare.com/workers-ai/features/markdown-conversion/) for more information. - `id: Literal["content_converter"]` ID of the zone setting. - `"content_converter"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Ciphers: …` An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - `id: Literal["ciphers"]` ID of the zone setting. - `"ciphers"` - `value: List[str]` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCNAMEFlattening: …` Whether or not cname flattening is on. - `id: Literal["cname_flattening"]` How to flatten the cname destination. - `"cname_flattening"` - `value: Literal["flatten_at_root", "flatten_all"]` Current value of the zone setting. - `"flatten_at_root"` - `"flatten_all"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class DevelopmentMode: …` Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. - `id: Literal["development_mode"]` ID of the zone setting. - `"development_mode"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `time_remaining: Optional[float]` Value of the zone setting. Notes: 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 false. - `class EarlyHints: …` When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. - `id: Literal["early_hints"]` ID of the zone setting. - `"early_hints"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEdgeCacheTTL: …` Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. - `id: Literal["edge_cache_ttl"]` ID of the zone setting. - `"edge_cache_ttl"` - `value: Literal[30, 60, 300, 18 more]` Current value of the zone setting. - `30` - `60` - `300` - `1200` - `1800` - `3600` - `7200` - `10800` - `14400` - `18000` - `28800` - `43200` - `57600` - `72000` - `86400` - `172800` - `259200` - `345600` - `432000` - `518400` - `604800` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEmailObfuscation: …` Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). - `id: Literal["email_obfuscation"]` ID of the zone setting. - `"email_obfuscation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class H2Prioritization: …` HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - `id: Literal["h2_prioritization"]` ID of the zone setting. - `"h2_prioritization"` - `value: Literal["on", "off", "custom"]` Current value of the zone setting. - `"on"` - `"off"` - `"custom"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HotlinkProtection: …` When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). - `id: Literal["hotlink_protection"]` ID of the zone setting. - `"hotlink_protection"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP2: …` HTTP2 enabled for this zone. - `id: Literal["http2"]` ID of the zone setting. - `"http2"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP3: …` HTTP3 enabled for this zone. - `id: Literal["http3"]` ID of the zone setting. - `"http3"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ImageResizing: …` Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. - `id: Literal["image_resizing"]` ID of the zone setting. - `"image_resizing"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasIPGeolocation: …` Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). - `id: Literal["ip_geolocation"]` ID of the zone setting. - `"ip_geolocation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class IPV6: …` Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). - `id: Literal["ipv6"]` ID of the zone setting. - `"ipv6"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesMaxUpload: …` Maximum size of an allowable upload. - `id: Literal["max_upload"]` identifier of the zone setting. - `"max_upload"` - `value: Literal[100, 125, 150, 15 more]` Current value of the zone setting. - `100` - `125` - `150` - `175` - `200` - `225` - `250` - `275` - `300` - `325` - `350` - `375` - `400` - `425` - `450` - `475` - `500` - `1000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class MinTLSVersion: …` Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. - `id: Literal["min_tls_version"]` ID of the zone setting. - `"min_tls_version"` - `value: Literal["1.0", "1.1", "1.2", "1.3"]` Current value of the zone setting. - `"1.0"` - `"1.1"` - `"1.2"` - `"1.3"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasMirage: …` Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. - `id: Literal["mirage"]` ID of the zone setting. - `"mirage"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class NEL: …` Enable Network Error Logging reporting on your zone. (Beta) - `id: Literal["nel"]` Zone setting identifier. - `"nel"` - `value: Value` Current value of the zone setting. - `enabled: Optional[bool]` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOpportunisticEncryption: …` Enables the Opportunistic Encryption feature for a zone. - `id: Literal["opportunistic_encryption"]` ID of the zone setting. - `"opportunistic_encryption"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OpportunisticOnion: …` Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. - `id: Literal["opportunistic_onion"]` ID of the zone setting. - `"opportunistic_onion"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OrangeToOrange: …` Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - `id: Literal["orange_to_orange"]` ID of the zone setting. - `"orange_to_orange"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOriginErrorPagePassThru: …` Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. - `id: Literal["origin_error_page_pass_thru"]` ID of the zone setting. - `"origin_error_page_pass_thru"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesOriginH2MaxStreams: …` Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. - `id: Literal["origin_h2_max_streams"]` Value of the zone setting. - `"origin_h2_max_streams"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[int]` Value of the Origin H2 Max Streams Setting. - `class ZonesCacheRulesOriginMaxHTTPVersion: …` Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1". - `id: Literal["origin_max_http_version"]` Value of the zone setting. - `"origin_max_http_version"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[Literal["2", "1"]]` Value of the Origin Max HTTP Version Setting. - `"2"` - `"1"` - `class ZonesSchemasPolish: …` Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. - `id: Literal["polish"]` ID of the zone setting. - `"polish"` - `value: Literal["off", "lossless", "lossy"]` Current value of the zone setting. - `"off"` - `"lossless"` - `"lossy"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PrefetchPreload: …` Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - `id: Literal["prefetch_preload"]` ID of the zone setting. - `"prefetch_preload"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesPrivacyPass: …` Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). - `id: Literal["privacy_pass"]` ID of the zone setting. - `"privacy_pass"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ProxyReadTimeout: …` Maximum time between two read operations from origin. - `id: Literal["proxy_read_timeout"]` ID of the zone setting. - `"proxy_read_timeout"` - `value: float` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PseudoIPV4: …` The value set for the Pseudo IPv4 setting. - `id: Literal["pseudo_ipv4"]` Value of the Pseudo IPv4 setting. - `"pseudo_ipv4"` - `value: Literal["off", "add_header", "overwrite_header"]` Current value of the zone setting. - `"off"` - `"add_header"` - `"overwrite_header"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesRedirectsForAITraining: …` When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. - `id: Literal["redirects_for_ai_training"]` ID of the zone setting. - `"redirects_for_ai_training"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesReplaceInsecureJS: …` Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. - `id: Literal["replace_insecure_js"]` ID of the zone setting. - `"replace_insecure_js"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasResponseBuffering: …` Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. - `id: Literal["response_buffering"]` ID of the zone setting. - `"response_buffering"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasRocketLoader: …` Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. - `id: Literal["rocket_loader"]` ID of the zone setting. - `"rocket_loader"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticPlatformOptimization: …` [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. - `id: Literal["automatic_platform_optimization"]` ID of the zone setting. - `"automatic_platform_optimization"` - `value: AutomaticPlatformOptimization` Current value of the zone setting. - `cache_by_device_type: bool` Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. - `cf: bool` Indicates whether or not Cloudflare proxy is enabled. - `enabled: bool` Indicates whether or not Automatic Platform Optimization is enabled. - `hostnames: List[str]` An array of hostnames where Automatic Platform Optimization for WordPress is activated. - `wordpress: bool` Indicates whether or not site is powered by WordPress. - `wp_plugin: bool` Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SecurityHeaders: …` Cloudflare security header for a zone. - `id: Literal["security_header"]` ID of the zone's security header. - `"security_header"` - `value: Value` Current value of the zone setting. - `strict_transport_security: Optional[ValueStrictTransportSecurity]` Strict Transport Security. - `enabled: Optional[bool]` Whether or not strict transport security is enabled. - `include_subdomains: Optional[bool]` Include all subdomains for strict transport security. - `max_age: Optional[float]` Max age in seconds of the strict transport security. - `nosniff: Optional[bool]` Whether or not to include 'X-Content-Type-Options: nosniff' header. - `preload: Optional[bool]` Enable automatic preload of the HSTS configuration. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSecurityLevel: …` Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). - `id: Literal["security_level"]` ID of the zone setting. - `"security_level"` - `value: Literal["off", "essentially_off", "low", 3 more]` Current value of the zone setting. - `"off"` - `"essentially_off"` - `"low"` - `"medium"` - `"high"` - `"under_attack"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ServerSideExcludes: …` If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). - `id: Literal["server_side_exclude"]` ID of the zone setting. - `"server_side_exclude"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSha1Support: …` Allow SHA1 support. - `id: Literal["sha1_support"]` Zone setting identifier. - `"sha1_support"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSortQueryStringForCache: …` Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. - `id: Literal["sort_query_string_for_cache"]` ID of the zone setting. - `"sort_query_string_for_cache"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSSL: …` SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). - `id: Literal["ssl"]` ID of the zone setting. - `"ssl"` - `value: Literal["off", "flexible", "full", "strict"]` Current value of the zone setting. - `"off"` - `"flexible"` - `"full"` - `"strict"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SSLRecommender: …` Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - `id: Optional[Literal["ssl_recommender"]]` Enrollment value for SSL/TLS Recommender. - `"ssl_recommender"` - `enabled: Optional[bool]` ssl-recommender enrollment setting. - `class ZonesTLS1_2Only: …` Only allows TLS1.2. - `id: Literal["tls_1_2_only"]` Zone setting identifier. - `"tls_1_2_only"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLS1_3: …` Enables Crypto TLS 1.3 feature for a zone. - `id: Literal["tls_1_3"]` ID of the zone setting. - `"tls_1_3"` - `value: Literal["on", "off", "zrt"]` Current value of the zone setting. - `"on"` - `"off"` - `"zrt"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLSClientAuth: …` TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - `id: Literal["tls_client_auth"]` ID of the zone setting. - `"tls_client_auth"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformations: …` Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformationsAllowedOrigins: …` Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations_allowed_origins"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations_allowed_origins"` - `value: str` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasTrueClientIPHeader: …` Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - `id: Literal["true_client_ip_header"]` ID of the zone setting. - `"true_client_ip_header"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasWAF: …` The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). - `id: Literal["waf"]` ID of the zone setting. - `"waf"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class WebP: …` When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. - `id: Literal["webp"]` ID of the zone setting. - `"webp"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Websocket: …` WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). - `id: Literal["websockets"]` ID of the zone setting. - `"websockets"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) setting = client.zones.settings.get( setting_id="always_online", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(setting) ``` #### Response ```json { "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": "0rtt", "value": "on", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } ``` ## Edit zone setting `zones.settings.edit(strsetting_id, SettingEditParams**kwargs) -> SettingEditResponse` **patch** `/zones/{zone_id}/settings/{setting_id}` Updates a single zone setting by the identifier ### Parameters - `zone_id: str` Identifier - `setting_id: str` Setting name - `enabled: Optional[bool]` ssl-recommender enrollment setting. ### Returns - `SettingEditResponse` 0-RTT session resumption enabled for this zone. - `class ZeroRTT: …` 0-RTT session resumption enabled for this zone. - `id: Literal["0rtt"]` ID of the zone setting. - `"0rtt"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class AdvancedDDoS: …` Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - `id: Literal["advanced_ddos"]` ID of the zone setting. - `"advanced_ddos"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesAegis: …` Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. - `id: Literal["aegis"]` ID of the zone setting. - `"aegis"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[ZonesCacheRulesAegisValue]` Value of the zone setting. - `enabled: Optional[bool]` Whether the feature is enabled or not. - `pool_id: Optional[str]` Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. - `class AlwaysOnline: …` When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. - `id: Literal["always_online"]` ID of the zone setting. - `"always_online"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAlwaysUseHTTPS: …` Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. - `id: Literal["always_use_https"]` ID of the zone setting. - `"always_use_https"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticHTTPSRewrites: …` Enable the Automatic HTTPS Rewrites feature for this zone. - `id: Literal["automatic_https_rewrites"]` ID of the zone setting. - `"automatic_https_rewrites"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Brotli: …` When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. - `id: Literal["brotli"]` ID of the zone setting. - `"brotli"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCacheTTL: …` Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). - `id: Literal["browser_cache_ttl"]` ID of the zone setting. - `"browser_cache_ttl"` - `value: int` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCheck: …` Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). - `id: Literal["browser_check"]` ID of the zone setting. - `"browser_check"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasCacheLevel: …` Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). - `id: Literal["cache_level"]` ID of the zone setting. - `"cache_level"` - `value: Literal["aggressive", "basic", "simplified"]` Current value of the zone setting. - `"aggressive"` - `"basic"` - `"simplified"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ChallengeTTL: …` Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). - `id: Literal["challenge_ttl"]` ID of the zone setting. - `"challenge_ttl"` - `value: Literal[300, 900, 1800, 11 more]` Current value of the zone setting. - `300` - `900` - `1800` - `2700` - `3600` - `7200` - `10800` - `14400` - `28800` - `57600` - `86400` - `604800` - `2592000` - `31536000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesChinaNetworkEnabled: …` Determines whether or not the china network is enabled. - `id: Literal["china_network_enabled"]` ID of the zone setting. - `"china_network_enabled"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesContentConverter: …` When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the [developer documentation](https://developers.cloudflare.com/workers-ai/features/markdown-conversion/) for more information. - `id: Literal["content_converter"]` ID of the zone setting. - `"content_converter"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Ciphers: …` An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - `id: Literal["ciphers"]` ID of the zone setting. - `"ciphers"` - `value: List[str]` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCNAMEFlattening: …` Whether or not cname flattening is on. - `id: Literal["cname_flattening"]` How to flatten the cname destination. - `"cname_flattening"` - `value: Literal["flatten_at_root", "flatten_all"]` Current value of the zone setting. - `"flatten_at_root"` - `"flatten_all"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class DevelopmentMode: …` Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. - `id: Literal["development_mode"]` ID of the zone setting. - `"development_mode"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `time_remaining: Optional[float]` Value of the zone setting. Notes: 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 false. - `class EarlyHints: …` When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. - `id: Literal["early_hints"]` ID of the zone setting. - `"early_hints"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEdgeCacheTTL: …` Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. - `id: Literal["edge_cache_ttl"]` ID of the zone setting. - `"edge_cache_ttl"` - `value: Literal[30, 60, 300, 18 more]` Current value of the zone setting. - `30` - `60` - `300` - `1200` - `1800` - `3600` - `7200` - `10800` - `14400` - `18000` - `28800` - `43200` - `57600` - `72000` - `86400` - `172800` - `259200` - `345600` - `432000` - `518400` - `604800` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEmailObfuscation: …` Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). - `id: Literal["email_obfuscation"]` ID of the zone setting. - `"email_obfuscation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class H2Prioritization: …` HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - `id: Literal["h2_prioritization"]` ID of the zone setting. - `"h2_prioritization"` - `value: Literal["on", "off", "custom"]` Current value of the zone setting. - `"on"` - `"off"` - `"custom"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HotlinkProtection: …` When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). - `id: Literal["hotlink_protection"]` ID of the zone setting. - `"hotlink_protection"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP2: …` HTTP2 enabled for this zone. - `id: Literal["http2"]` ID of the zone setting. - `"http2"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP3: …` HTTP3 enabled for this zone. - `id: Literal["http3"]` ID of the zone setting. - `"http3"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ImageResizing: …` Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. - `id: Literal["image_resizing"]` ID of the zone setting. - `"image_resizing"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasIPGeolocation: …` Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). - `id: Literal["ip_geolocation"]` ID of the zone setting. - `"ip_geolocation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class IPV6: …` Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). - `id: Literal["ipv6"]` ID of the zone setting. - `"ipv6"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesMaxUpload: …` Maximum size of an allowable upload. - `id: Literal["max_upload"]` identifier of the zone setting. - `"max_upload"` - `value: Literal[100, 125, 150, 15 more]` Current value of the zone setting. - `100` - `125` - `150` - `175` - `200` - `225` - `250` - `275` - `300` - `325` - `350` - `375` - `400` - `425` - `450` - `475` - `500` - `1000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class MinTLSVersion: …` Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. - `id: Literal["min_tls_version"]` ID of the zone setting. - `"min_tls_version"` - `value: Literal["1.0", "1.1", "1.2", "1.3"]` Current value of the zone setting. - `"1.0"` - `"1.1"` - `"1.2"` - `"1.3"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasMirage: …` Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. - `id: Literal["mirage"]` ID of the zone setting. - `"mirage"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class NEL: …` Enable Network Error Logging reporting on your zone. (Beta) - `id: Literal["nel"]` Zone setting identifier. - `"nel"` - `value: Value` Current value of the zone setting. - `enabled: Optional[bool]` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOpportunisticEncryption: …` Enables the Opportunistic Encryption feature for a zone. - `id: Literal["opportunistic_encryption"]` ID of the zone setting. - `"opportunistic_encryption"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OpportunisticOnion: …` Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. - `id: Literal["opportunistic_onion"]` ID of the zone setting. - `"opportunistic_onion"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OrangeToOrange: …` Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - `id: Literal["orange_to_orange"]` ID of the zone setting. - `"orange_to_orange"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOriginErrorPagePassThru: …` Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. - `id: Literal["origin_error_page_pass_thru"]` ID of the zone setting. - `"origin_error_page_pass_thru"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesOriginH2MaxStreams: …` Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. - `id: Literal["origin_h2_max_streams"]` Value of the zone setting. - `"origin_h2_max_streams"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[int]` Value of the Origin H2 Max Streams Setting. - `class ZonesCacheRulesOriginMaxHTTPVersion: …` Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1". - `id: Literal["origin_max_http_version"]` Value of the zone setting. - `"origin_max_http_version"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[Literal["2", "1"]]` Value of the Origin Max HTTP Version Setting. - `"2"` - `"1"` - `class ZonesSchemasPolish: …` Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. - `id: Literal["polish"]` ID of the zone setting. - `"polish"` - `value: Literal["off", "lossless", "lossy"]` Current value of the zone setting. - `"off"` - `"lossless"` - `"lossy"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PrefetchPreload: …` Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - `id: Literal["prefetch_preload"]` ID of the zone setting. - `"prefetch_preload"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesPrivacyPass: …` Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). - `id: Literal["privacy_pass"]` ID of the zone setting. - `"privacy_pass"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ProxyReadTimeout: …` Maximum time between two read operations from origin. - `id: Literal["proxy_read_timeout"]` ID of the zone setting. - `"proxy_read_timeout"` - `value: float` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PseudoIPV4: …` The value set for the Pseudo IPv4 setting. - `id: Literal["pseudo_ipv4"]` Value of the Pseudo IPv4 setting. - `"pseudo_ipv4"` - `value: Literal["off", "add_header", "overwrite_header"]` Current value of the zone setting. - `"off"` - `"add_header"` - `"overwrite_header"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesRedirectsForAITraining: …` When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. - `id: Literal["redirects_for_ai_training"]` ID of the zone setting. - `"redirects_for_ai_training"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesReplaceInsecureJS: …` Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. - `id: Literal["replace_insecure_js"]` ID of the zone setting. - `"replace_insecure_js"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasResponseBuffering: …` Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. - `id: Literal["response_buffering"]` ID of the zone setting. - `"response_buffering"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasRocketLoader: …` Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. - `id: Literal["rocket_loader"]` ID of the zone setting. - `"rocket_loader"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticPlatformOptimization: …` [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. - `id: Literal["automatic_platform_optimization"]` ID of the zone setting. - `"automatic_platform_optimization"` - `value: AutomaticPlatformOptimization` Current value of the zone setting. - `cache_by_device_type: bool` Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. - `cf: bool` Indicates whether or not Cloudflare proxy is enabled. - `enabled: bool` Indicates whether or not Automatic Platform Optimization is enabled. - `hostnames: List[str]` An array of hostnames where Automatic Platform Optimization for WordPress is activated. - `wordpress: bool` Indicates whether or not site is powered by WordPress. - `wp_plugin: bool` Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SecurityHeaders: …` Cloudflare security header for a zone. - `id: Literal["security_header"]` ID of the zone's security header. - `"security_header"` - `value: Value` Current value of the zone setting. - `strict_transport_security: Optional[ValueStrictTransportSecurity]` Strict Transport Security. - `enabled: Optional[bool]` Whether or not strict transport security is enabled. - `include_subdomains: Optional[bool]` Include all subdomains for strict transport security. - `max_age: Optional[float]` Max age in seconds of the strict transport security. - `nosniff: Optional[bool]` Whether or not to include 'X-Content-Type-Options: nosniff' header. - `preload: Optional[bool]` Enable automatic preload of the HSTS configuration. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSecurityLevel: …` Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). - `id: Literal["security_level"]` ID of the zone setting. - `"security_level"` - `value: Literal["off", "essentially_off", "low", 3 more]` Current value of the zone setting. - `"off"` - `"essentially_off"` - `"low"` - `"medium"` - `"high"` - `"under_attack"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ServerSideExcludes: …` If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). - `id: Literal["server_side_exclude"]` ID of the zone setting. - `"server_side_exclude"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSha1Support: …` Allow SHA1 support. - `id: Literal["sha1_support"]` Zone setting identifier. - `"sha1_support"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSortQueryStringForCache: …` Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. - `id: Literal["sort_query_string_for_cache"]` ID of the zone setting. - `"sort_query_string_for_cache"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSSL: …` SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). - `id: Literal["ssl"]` ID of the zone setting. - `"ssl"` - `value: Literal["off", "flexible", "full", "strict"]` Current value of the zone setting. - `"off"` - `"flexible"` - `"full"` - `"strict"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SSLRecommender: …` Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - `id: Optional[Literal["ssl_recommender"]]` Enrollment value for SSL/TLS Recommender. - `"ssl_recommender"` - `enabled: Optional[bool]` ssl-recommender enrollment setting. - `class ZonesTLS1_2Only: …` Only allows TLS1.2. - `id: Literal["tls_1_2_only"]` Zone setting identifier. - `"tls_1_2_only"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLS1_3: …` Enables Crypto TLS 1.3 feature for a zone. - `id: Literal["tls_1_3"]` ID of the zone setting. - `"tls_1_3"` - `value: Literal["on", "off", "zrt"]` Current value of the zone setting. - `"on"` - `"off"` - `"zrt"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLSClientAuth: …` TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - `id: Literal["tls_client_auth"]` ID of the zone setting. - `"tls_client_auth"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformations: …` Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformationsAllowedOrigins: …` Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations_allowed_origins"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations_allowed_origins"` - `value: str` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasTrueClientIPHeader: …` Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - `id: Literal["true_client_ip_header"]` ID of the zone setting. - `"true_client_ip_header"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasWAF: …` The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). - `id: Literal["waf"]` ID of the zone setting. - `"waf"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class WebP: …` When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. - `id: Literal["webp"]` ID of the zone setting. - `"webp"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Websocket: …` WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). - `id: Literal["websockets"]` ID of the zone setting. - `"websockets"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.zones.settings.edit( setting_id="always_online", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response) ``` #### Response ```json { "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": "0rtt", "value": "on", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } ``` ## Domain Types ### Advanced DDoS - `class AdvancedDDoS: …` Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - `id: Literal["advanced_ddos"]` ID of the zone setting. - `"advanced_ddos"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Aegis - `class Aegis: …` Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. - `id: Literal["aegis"]` ID of the zone setting. - `"aegis"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[Value]` Value of the zone setting. - `enabled: Optional[bool]` Whether the feature is enabled or not. - `pool_id: Optional[str]` Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. ### Always Online - `class AlwaysOnline: …` When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. - `id: Literal["always_online"]` ID of the zone setting. - `"always_online"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Always Use HTTPS - `class AlwaysUseHTTPS: …` - `id: Optional[Literal["always_use_https"]]` If enabled, any `http://`` URL is converted to`https://` through a 301 redirect. - `"always_use_https"` ### Automatic HTTPS Rewrites - `class AutomaticHTTPSRewrites: …` - `id: Optional[Literal["automatic_https_rewrites"]]` Turn on or off Automatic HTTPS Rewrites. - `"automatic_https_rewrites"` - `value: Optional[Literal["on", "off"]]` The status of Automatic HTTPS Rewrites. - `"on"` - `"off"` ### Automatic Platform Optimization - `class AutomaticPlatformOptimization: …` - `cache_by_device_type: bool` Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. - `cf: bool` Indicates whether or not Cloudflare proxy is enabled. - `enabled: bool` Indicates whether or not Automatic Platform Optimization is enabled. - `hostnames: List[str]` An array of hostnames where Automatic Platform Optimization for WordPress is activated. - `wordpress: bool` Indicates whether or not site is powered by WordPress. - `wp_plugin: bool` Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. ### Brotli - `class Brotli: …` When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. - `id: Literal["brotli"]` ID of the zone setting. - `"brotli"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Browser Cache TTL - `class BrowserCacheTTL: …` - `id: Optional[Literal["browser_cache_ttl"]]` Control how long resources cached by client browsers remain valid. - `"browser_cache_ttl"` - `value: Optional[int]` The number of seconds to cache resources for. Setting this to 0 enables "Respect Existing Headers". ### Browser Check - `class BrowserCheck: …` - `id: Optional[Literal["browser_check"]]` Inspect the visitor's browser for headers commonly associated with spammers and certain bots. - `"browser_check"` - `value: Optional[Literal["on", "off"]]` The status of Browser Integrity Check. - `"on"` - `"off"` ### Cache Level - `class CacheLevel: …` - `id: Optional[Literal["cache_level"]]` Apply custom caching based on the option selected. - `"cache_level"` - `value: Optional[Literal["bypass", "basic", "simplified", 2 more]]` * `bypass`: Cloudflare does not cache. * `basic`: Delivers resources from cache when there is no query string. * `simplified`: Delivers the same resource to everyone independent of the query string. * `aggressive`: Caches all static content that has a query string. * `cache_everything`: Treats all content as static and caches all file types beyond the [Cloudflare default cached content](https://developers.cloudflare.com/cache/concepts/default-cache-behavior/#default-cached-file-extensions). - `"bypass"` - `"basic"` - `"simplified"` - `"aggressive"` - `"cache_everything"` ### Challenge TTL - `class ChallengeTTL: …` Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). - `id: Literal["challenge_ttl"]` ID of the zone setting. - `"challenge_ttl"` - `value: Literal[300, 900, 1800, 11 more]` Current value of the zone setting. - `300` - `900` - `1800` - `2700` - `3600` - `7200` - `10800` - `14400` - `28800` - `57600` - `86400` - `604800` - `2592000` - `31536000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Ciphers - `class Ciphers: …` An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - `id: Literal["ciphers"]` ID of the zone setting. - `"ciphers"` - `value: List[str]` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Development Mode - `class DevelopmentMode: …` Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. - `id: Literal["development_mode"]` ID of the zone setting. - `"development_mode"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `time_remaining: Optional[float]` Value of the zone setting. Notes: 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 false. ### Early Hints - `class EarlyHints: …` When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. - `id: Literal["early_hints"]` ID of the zone setting. - `"early_hints"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Email Obfuscation - `class EmailObfuscation: …` - `id: Optional[Literal["email_obfuscation"]]` Turn on or off **Email Obfuscation**. - `"email_obfuscation"` - `value: Optional[Literal["on", "off"]]` The status of Email Obfuscation. - `"on"` - `"off"` ### Font Settings - `class FontSettings: …` Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information. - `id: Optional[Literal["fonts"]]` ID of the zone setting. - `"fonts"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `value: Optional[Literal["on", "off"]]` Current value of the zone setting. - `"on"` - `"off"` ### H2 Prioritization - `class H2Prioritization: …` HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - `id: Literal["h2_prioritization"]` ID of the zone setting. - `"h2_prioritization"` - `value: Literal["on", "off", "custom"]` Current value of the zone setting. - `"on"` - `"off"` - `"custom"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Hotlink Protection - `class HotlinkProtection: …` When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). - `id: Literal["hotlink_protection"]` ID of the zone setting. - `"hotlink_protection"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### HTTP2 - `class HTTP2: …` HTTP2 enabled for this zone. - `id: Literal["http2"]` ID of the zone setting. - `"http2"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### HTTP3 - `class HTTP3: …` HTTP3 enabled for this zone. - `id: Literal["http3"]` ID of the zone setting. - `"http3"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Image Resizing - `class ImageResizing: …` Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. - `id: Literal["image_resizing"]` ID of the zone setting. - `"image_resizing"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### IP Geolocation - `class IPGeolocation: …` - `id: Optional[Literal["ip_geolocation"]]` Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor. - `"ip_geolocation"` - `value: Optional[Literal["on", "off"]]` The status of adding the IP Geolocation Header. - `"on"` - `"off"` ### IPV6 - `class IPV6: …` Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). - `id: Literal["ipv6"]` ID of the zone setting. - `"ipv6"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Min TLS Version - `class MinTLSVersion: …` Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. - `id: Literal["min_tls_version"]` ID of the zone setting. - `"min_tls_version"` - `value: Literal["1.0", "1.1", "1.2", "1.3"]` Current value of the zone setting. - `"1.0"` - `"1.1"` - `"1.2"` - `"1.3"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Mirage - `class Mirage: …` - `id: Optional[Literal["mirage"]]` Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1. - `"mirage"` - `value: Optional[Literal["on", "off"]]` The status of Mirage. - `"on"` - `"off"` ### NEL - `class NEL: …` Enable Network Error Logging reporting on your zone. (Beta) - `id: Literal["nel"]` Zone setting identifier. - `"nel"` - `value: Value` Current value of the zone setting. - `enabled: Optional[bool]` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Opportunistic Encryption - `class OpportunisticEncryption: …` - `id: Optional[Literal["opportunistic_encryption"]]` Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel. It's not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests. - `"opportunistic_encryption"` - `value: Optional[Literal["on", "off"]]` The status of Opportunistic Encryption. - `"on"` - `"off"` ### Opportunistic Onion - `class OpportunisticOnion: …` Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. - `id: Literal["opportunistic_onion"]` ID of the zone setting. - `"opportunistic_onion"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Orange To Orange - `class OrangeToOrange: …` Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - `id: Literal["orange_to_orange"]` ID of the zone setting. - `"orange_to_orange"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Origin Error Page Pass Thru - `class OriginErrorPagePassThru: …` - `id: Optional[Literal["origin_error_page_pass_thru"]]` Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin. - `"origin_error_page_pass_thru"` - `value: Optional[Literal["on", "off"]]` The status of Origin Error Page Passthru. - `"on"` - `"off"` ### Origin Max HTTP Version - `class OriginMaxHTTPVersion: …` - `id: Literal["origin_max_http_version"]` The identifier of the caching setting. - `"origin_max_http_version"` - `editable: bool` Whether the setting is editable. - `value: Literal["2", "1"]` Value of the Origin Max HTTP Version Setting. - `"2"` - `"1"` - `modified_on: Optional[datetime]` Last time this setting was modified. ### Polish - `class Polish: …` - `id: Optional[Literal["polish"]]` Apply options from the Polish feature of the Cloudflare Speed app. - `"polish"` - `value: Optional[Literal["off", "lossless", "lossy"]]` The level of Polish you want applied to your origin. - `"off"` - `"lossless"` - `"lossy"` ### Prefetch Preload - `class PrefetchPreload: …` Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - `id: Literal["prefetch_preload"]` ID of the zone setting. - `"prefetch_preload"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Proxy Read Timeout - `class ProxyReadTimeout: …` Maximum time between two read operations from origin. - `id: Literal["proxy_read_timeout"]` ID of the zone setting. - `"proxy_read_timeout"` - `value: float` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Pseudo IPV4 - `class PseudoIPV4: …` The value set for the Pseudo IPv4 setting. - `id: Literal["pseudo_ipv4"]` Value of the Pseudo IPv4 setting. - `"pseudo_ipv4"` - `value: Literal["off", "add_header", "overwrite_header"]` Current value of the zone setting. - `"off"` - `"add_header"` - `"overwrite_header"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Response Buffering - `class ResponseBuffering: …` - `id: Optional[Literal["response_buffering"]]` Turn on or off whether Cloudflare should wait for an entire file from the origin server before forwarding it to the site visitor. By default, Cloudflare sends packets to the client as they arrive from the origin server. - `"response_buffering"` - `value: Optional[Literal["on", "off"]]` The status of Response Buffering - `"on"` - `"off"` ### Rocket Loader - `class RocketLoader: …` - `id: Optional[Literal["rocket_loader"]]` Turn on or off Rocket Loader in the Cloudflare Speed app. - `"rocket_loader"` - `value: Optional[Literal["on", "off"]]` The status of Rocket Loader - `"on"` - `"off"` ### Security Headers - `class SecurityHeaders: …` Cloudflare security header for a zone. - `id: Literal["security_header"]` ID of the zone's security header. - `"security_header"` - `value: Value` Current value of the zone setting. - `strict_transport_security: Optional[ValueStrictTransportSecurity]` Strict Transport Security. - `enabled: Optional[bool]` Whether or not strict transport security is enabled. - `include_subdomains: Optional[bool]` Include all subdomains for strict transport security. - `max_age: Optional[float]` Max age in seconds of the strict transport security. - `nosniff: Optional[bool]` Whether or not to include 'X-Content-Type-Options: nosniff' header. - `preload: Optional[bool]` Enable automatic preload of the HSTS configuration. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Security Level - `class SecurityLevel: …` - `id: Optional[Literal["security_level"]]` Control options for the **Security Level** feature from the **Security** app. - `"security_level"` - `value: Optional[Literal["off", "essentially_off", "low", 3 more]]` - `"off"` - `"essentially_off"` - `"low"` - `"medium"` - `"high"` - `"under_attack"` ### Server Side Excludes - `class ServerSideExcludes: …` If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). - `id: Literal["server_side_exclude"]` ID of the zone setting. - `"server_side_exclude"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Sort Query String For Cache - `class SortQueryStringForCache: …` - `id: Optional[Literal["sort_query_string_for_cache"]]` Turn on or off the reordering of query strings. When query strings have the same structure, caching improves. - `"sort_query_string_for_cache"` - `value: Optional[Literal["on", "off"]]` The status of Query String Sort - `"on"` - `"off"` ### SSL - `class SSL: …` - `id: Optional[Literal["ssl"]]` Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app. - `"ssl"` - `value: Optional[Literal["off", "flexible", "full", 2 more]]` The encryption mode that Cloudflare uses to connect to your origin server. - `"off"` - `"flexible"` - `"full"` - `"strict"` - `"origin_pull"` ### SSL Recommender - `class SSLRecommender: …` Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - `id: Optional[Literal["ssl_recommender"]]` Enrollment value for SSL/TLS Recommender. - `"ssl_recommender"` - `enabled: Optional[bool]` ssl-recommender enrollment setting. ### TLS 1 3 - `class TLS1_3: …` Enables Crypto TLS 1.3 feature for a zone. - `id: Literal["tls_1_3"]` ID of the zone setting. - `"tls_1_3"` - `value: Literal["on", "off", "zrt"]` Current value of the zone setting. - `"on"` - `"off"` - `"zrt"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### TLS Client Auth - `class TLSClientAuth: …` TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - `id: Literal["tls_client_auth"]` ID of the zone setting. - `"tls_client_auth"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### True Client IP Header - `class TrueClientIPHeader: …` - `id: Optional[Literal["true_client_ip_header"]]` Turn on or off the True-Client-IP Header feature of the Cloudflare Network app. - `"true_client_ip_header"` - `value: Optional[Literal["on", "off"]]` The status of True Client IP Header. - `"on"` - `"off"` ### WAF - `class WAF: …` - `id: Optional[Literal["waf"]]` Turn on or off [WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/). You cannot enable or disable individual WAF managed rules via Page Rules. - `"waf"` - `value: Optional[Literal["on", "off"]]` The status of WAF managed rules (previous version). - `"on"` - `"off"` ### WebP - `class WebP: …` When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. - `id: Literal["webp"]` ID of the zone setting. - `"webp"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Websocket - `class Websocket: …` WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). - `id: Literal["websockets"]` ID of the zone setting. - `"websockets"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Zero RTT - `class ZeroRTT: …` 0-RTT session resumption enabled for this zone. - `id: Literal["0rtt"]` ID of the zone setting. - `"0rtt"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Setting Get Response - `SettingGetResponse` 0-RTT session resumption enabled for this zone. - `class ZeroRTT: …` 0-RTT session resumption enabled for this zone. - `id: Literal["0rtt"]` ID of the zone setting. - `"0rtt"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class AdvancedDDoS: …` Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - `id: Literal["advanced_ddos"]` ID of the zone setting. - `"advanced_ddos"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesAegis: …` Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. - `id: Literal["aegis"]` ID of the zone setting. - `"aegis"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[ZonesCacheRulesAegisValue]` Value of the zone setting. - `enabled: Optional[bool]` Whether the feature is enabled or not. - `pool_id: Optional[str]` Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. - `class AlwaysOnline: …` When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. - `id: Literal["always_online"]` ID of the zone setting. - `"always_online"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAlwaysUseHTTPS: …` Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. - `id: Literal["always_use_https"]` ID of the zone setting. - `"always_use_https"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticHTTPSRewrites: …` Enable the Automatic HTTPS Rewrites feature for this zone. - `id: Literal["automatic_https_rewrites"]` ID of the zone setting. - `"automatic_https_rewrites"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Brotli: …` When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. - `id: Literal["brotli"]` ID of the zone setting. - `"brotli"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCacheTTL: …` Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). - `id: Literal["browser_cache_ttl"]` ID of the zone setting. - `"browser_cache_ttl"` - `value: int` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCheck: …` Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). - `id: Literal["browser_check"]` ID of the zone setting. - `"browser_check"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasCacheLevel: …` Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). - `id: Literal["cache_level"]` ID of the zone setting. - `"cache_level"` - `value: Literal["aggressive", "basic", "simplified"]` Current value of the zone setting. - `"aggressive"` - `"basic"` - `"simplified"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ChallengeTTL: …` Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). - `id: Literal["challenge_ttl"]` ID of the zone setting. - `"challenge_ttl"` - `value: Literal[300, 900, 1800, 11 more]` Current value of the zone setting. - `300` - `900` - `1800` - `2700` - `3600` - `7200` - `10800` - `14400` - `28800` - `57600` - `86400` - `604800` - `2592000` - `31536000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesChinaNetworkEnabled: …` Determines whether or not the china network is enabled. - `id: Literal["china_network_enabled"]` ID of the zone setting. - `"china_network_enabled"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesContentConverter: …` When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the [developer documentation](https://developers.cloudflare.com/workers-ai/features/markdown-conversion/) for more information. - `id: Literal["content_converter"]` ID of the zone setting. - `"content_converter"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Ciphers: …` An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - `id: Literal["ciphers"]` ID of the zone setting. - `"ciphers"` - `value: List[str]` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCNAMEFlattening: …` Whether or not cname flattening is on. - `id: Literal["cname_flattening"]` How to flatten the cname destination. - `"cname_flattening"` - `value: Literal["flatten_at_root", "flatten_all"]` Current value of the zone setting. - `"flatten_at_root"` - `"flatten_all"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class DevelopmentMode: …` Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. - `id: Literal["development_mode"]` ID of the zone setting. - `"development_mode"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `time_remaining: Optional[float]` Value of the zone setting. Notes: 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 false. - `class EarlyHints: …` When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. - `id: Literal["early_hints"]` ID of the zone setting. - `"early_hints"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEdgeCacheTTL: …` Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. - `id: Literal["edge_cache_ttl"]` ID of the zone setting. - `"edge_cache_ttl"` - `value: Literal[30, 60, 300, 18 more]` Current value of the zone setting. - `30` - `60` - `300` - `1200` - `1800` - `3600` - `7200` - `10800` - `14400` - `18000` - `28800` - `43200` - `57600` - `72000` - `86400` - `172800` - `259200` - `345600` - `432000` - `518400` - `604800` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEmailObfuscation: …` Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). - `id: Literal["email_obfuscation"]` ID of the zone setting. - `"email_obfuscation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class H2Prioritization: …` HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - `id: Literal["h2_prioritization"]` ID of the zone setting. - `"h2_prioritization"` - `value: Literal["on", "off", "custom"]` Current value of the zone setting. - `"on"` - `"off"` - `"custom"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HotlinkProtection: …` When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). - `id: Literal["hotlink_protection"]` ID of the zone setting. - `"hotlink_protection"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP2: …` HTTP2 enabled for this zone. - `id: Literal["http2"]` ID of the zone setting. - `"http2"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP3: …` HTTP3 enabled for this zone. - `id: Literal["http3"]` ID of the zone setting. - `"http3"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ImageResizing: …` Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. - `id: Literal["image_resizing"]` ID of the zone setting. - `"image_resizing"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasIPGeolocation: …` Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). - `id: Literal["ip_geolocation"]` ID of the zone setting. - `"ip_geolocation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class IPV6: …` Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). - `id: Literal["ipv6"]` ID of the zone setting. - `"ipv6"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesMaxUpload: …` Maximum size of an allowable upload. - `id: Literal["max_upload"]` identifier of the zone setting. - `"max_upload"` - `value: Literal[100, 125, 150, 15 more]` Current value of the zone setting. - `100` - `125` - `150` - `175` - `200` - `225` - `250` - `275` - `300` - `325` - `350` - `375` - `400` - `425` - `450` - `475` - `500` - `1000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class MinTLSVersion: …` Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. - `id: Literal["min_tls_version"]` ID of the zone setting. - `"min_tls_version"` - `value: Literal["1.0", "1.1", "1.2", "1.3"]` Current value of the zone setting. - `"1.0"` - `"1.1"` - `"1.2"` - `"1.3"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasMirage: …` Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. - `id: Literal["mirage"]` ID of the zone setting. - `"mirage"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class NEL: …` Enable Network Error Logging reporting on your zone. (Beta) - `id: Literal["nel"]` Zone setting identifier. - `"nel"` - `value: Value` Current value of the zone setting. - `enabled: Optional[bool]` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOpportunisticEncryption: …` Enables the Opportunistic Encryption feature for a zone. - `id: Literal["opportunistic_encryption"]` ID of the zone setting. - `"opportunistic_encryption"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OpportunisticOnion: …` Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. - `id: Literal["opportunistic_onion"]` ID of the zone setting. - `"opportunistic_onion"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OrangeToOrange: …` Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - `id: Literal["orange_to_orange"]` ID of the zone setting. - `"orange_to_orange"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOriginErrorPagePassThru: …` Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. - `id: Literal["origin_error_page_pass_thru"]` ID of the zone setting. - `"origin_error_page_pass_thru"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesOriginH2MaxStreams: …` Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. - `id: Literal["origin_h2_max_streams"]` Value of the zone setting. - `"origin_h2_max_streams"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[int]` Value of the Origin H2 Max Streams Setting. - `class ZonesCacheRulesOriginMaxHTTPVersion: …` Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1". - `id: Literal["origin_max_http_version"]` Value of the zone setting. - `"origin_max_http_version"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[Literal["2", "1"]]` Value of the Origin Max HTTP Version Setting. - `"2"` - `"1"` - `class ZonesSchemasPolish: …` Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. - `id: Literal["polish"]` ID of the zone setting. - `"polish"` - `value: Literal["off", "lossless", "lossy"]` Current value of the zone setting. - `"off"` - `"lossless"` - `"lossy"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PrefetchPreload: …` Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - `id: Literal["prefetch_preload"]` ID of the zone setting. - `"prefetch_preload"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesPrivacyPass: …` Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). - `id: Literal["privacy_pass"]` ID of the zone setting. - `"privacy_pass"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ProxyReadTimeout: …` Maximum time between two read operations from origin. - `id: Literal["proxy_read_timeout"]` ID of the zone setting. - `"proxy_read_timeout"` - `value: float` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PseudoIPV4: …` The value set for the Pseudo IPv4 setting. - `id: Literal["pseudo_ipv4"]` Value of the Pseudo IPv4 setting. - `"pseudo_ipv4"` - `value: Literal["off", "add_header", "overwrite_header"]` Current value of the zone setting. - `"off"` - `"add_header"` - `"overwrite_header"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesRedirectsForAITraining: …` When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. - `id: Literal["redirects_for_ai_training"]` ID of the zone setting. - `"redirects_for_ai_training"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesReplaceInsecureJS: …` Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. - `id: Literal["replace_insecure_js"]` ID of the zone setting. - `"replace_insecure_js"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasResponseBuffering: …` Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. - `id: Literal["response_buffering"]` ID of the zone setting. - `"response_buffering"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasRocketLoader: …` Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. - `id: Literal["rocket_loader"]` ID of the zone setting. - `"rocket_loader"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticPlatformOptimization: …` [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. - `id: Literal["automatic_platform_optimization"]` ID of the zone setting. - `"automatic_platform_optimization"` - `value: AutomaticPlatformOptimization` Current value of the zone setting. - `cache_by_device_type: bool` Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. - `cf: bool` Indicates whether or not Cloudflare proxy is enabled. - `enabled: bool` Indicates whether or not Automatic Platform Optimization is enabled. - `hostnames: List[str]` An array of hostnames where Automatic Platform Optimization for WordPress is activated. - `wordpress: bool` Indicates whether or not site is powered by WordPress. - `wp_plugin: bool` Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SecurityHeaders: …` Cloudflare security header for a zone. - `id: Literal["security_header"]` ID of the zone's security header. - `"security_header"` - `value: Value` Current value of the zone setting. - `strict_transport_security: Optional[ValueStrictTransportSecurity]` Strict Transport Security. - `enabled: Optional[bool]` Whether or not strict transport security is enabled. - `include_subdomains: Optional[bool]` Include all subdomains for strict transport security. - `max_age: Optional[float]` Max age in seconds of the strict transport security. - `nosniff: Optional[bool]` Whether or not to include 'X-Content-Type-Options: nosniff' header. - `preload: Optional[bool]` Enable automatic preload of the HSTS configuration. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSecurityLevel: …` Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). - `id: Literal["security_level"]` ID of the zone setting. - `"security_level"` - `value: Literal["off", "essentially_off", "low", 3 more]` Current value of the zone setting. - `"off"` - `"essentially_off"` - `"low"` - `"medium"` - `"high"` - `"under_attack"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ServerSideExcludes: …` If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). - `id: Literal["server_side_exclude"]` ID of the zone setting. - `"server_side_exclude"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSha1Support: …` Allow SHA1 support. - `id: Literal["sha1_support"]` Zone setting identifier. - `"sha1_support"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSortQueryStringForCache: …` Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. - `id: Literal["sort_query_string_for_cache"]` ID of the zone setting. - `"sort_query_string_for_cache"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSSL: …` SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). - `id: Literal["ssl"]` ID of the zone setting. - `"ssl"` - `value: Literal["off", "flexible", "full", "strict"]` Current value of the zone setting. - `"off"` - `"flexible"` - `"full"` - `"strict"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SSLRecommender: …` Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - `id: Optional[Literal["ssl_recommender"]]` Enrollment value for SSL/TLS Recommender. - `"ssl_recommender"` - `enabled: Optional[bool]` ssl-recommender enrollment setting. - `class ZonesTLS1_2Only: …` Only allows TLS1.2. - `id: Literal["tls_1_2_only"]` Zone setting identifier. - `"tls_1_2_only"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLS1_3: …` Enables Crypto TLS 1.3 feature for a zone. - `id: Literal["tls_1_3"]` ID of the zone setting. - `"tls_1_3"` - `value: Literal["on", "off", "zrt"]` Current value of the zone setting. - `"on"` - `"off"` - `"zrt"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLSClientAuth: …` TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - `id: Literal["tls_client_auth"]` ID of the zone setting. - `"tls_client_auth"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformations: …` Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformationsAllowedOrigins: …` Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations_allowed_origins"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations_allowed_origins"` - `value: str` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasTrueClientIPHeader: …` Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - `id: Literal["true_client_ip_header"]` ID of the zone setting. - `"true_client_ip_header"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasWAF: …` The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). - `id: Literal["waf"]` ID of the zone setting. - `"waf"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class WebP: …` When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. - `id: Literal["webp"]` ID of the zone setting. - `"webp"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Websocket: …` WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). - `id: Literal["websockets"]` ID of the zone setting. - `"websockets"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. ### Setting Edit Response - `SettingEditResponse` 0-RTT session resumption enabled for this zone. - `class ZeroRTT: …` 0-RTT session resumption enabled for this zone. - `id: Literal["0rtt"]` ID of the zone setting. - `"0rtt"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class AdvancedDDoS: …` Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - `id: Literal["advanced_ddos"]` ID of the zone setting. - `"advanced_ddos"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesAegis: …` Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. - `id: Literal["aegis"]` ID of the zone setting. - `"aegis"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[ZonesCacheRulesAegisValue]` Value of the zone setting. - `enabled: Optional[bool]` Whether the feature is enabled or not. - `pool_id: Optional[str]` Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. - `class AlwaysOnline: …` When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. - `id: Literal["always_online"]` ID of the zone setting. - `"always_online"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAlwaysUseHTTPS: …` Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. - `id: Literal["always_use_https"]` ID of the zone setting. - `"always_use_https"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticHTTPSRewrites: …` Enable the Automatic HTTPS Rewrites feature for this zone. - `id: Literal["automatic_https_rewrites"]` ID of the zone setting. - `"automatic_https_rewrites"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Brotli: …` When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. - `id: Literal["brotli"]` ID of the zone setting. - `"brotli"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCacheTTL: …` Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). - `id: Literal["browser_cache_ttl"]` ID of the zone setting. - `"browser_cache_ttl"` - `value: int` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasBrowserCheck: …` Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). - `id: Literal["browser_check"]` ID of the zone setting. - `"browser_check"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasCacheLevel: …` Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). - `id: Literal["cache_level"]` ID of the zone setting. - `"cache_level"` - `value: Literal["aggressive", "basic", "simplified"]` Current value of the zone setting. - `"aggressive"` - `"basic"` - `"simplified"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ChallengeTTL: …` Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). - `id: Literal["challenge_ttl"]` ID of the zone setting. - `"challenge_ttl"` - `value: Literal[300, 900, 1800, 11 more]` Current value of the zone setting. - `300` - `900` - `1800` - `2700` - `3600` - `7200` - `10800` - `14400` - `28800` - `57600` - `86400` - `604800` - `2592000` - `31536000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesChinaNetworkEnabled: …` Determines whether or not the china network is enabled. - `id: Literal["china_network_enabled"]` ID of the zone setting. - `"china_network_enabled"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesContentConverter: …` When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the [developer documentation](https://developers.cloudflare.com/workers-ai/features/markdown-conversion/) for more information. - `id: Literal["content_converter"]` ID of the zone setting. - `"content_converter"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Ciphers: …` An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - `id: Literal["ciphers"]` ID of the zone setting. - `"ciphers"` - `value: List[str]` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCNAMEFlattening: …` Whether or not cname flattening is on. - `id: Literal["cname_flattening"]` How to flatten the cname destination. - `"cname_flattening"` - `value: Literal["flatten_at_root", "flatten_all"]` Current value of the zone setting. - `"flatten_at_root"` - `"flatten_all"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class DevelopmentMode: …` Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. - `id: Literal["development_mode"]` ID of the zone setting. - `"development_mode"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `time_remaining: Optional[float]` Value of the zone setting. Notes: 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 false. - `class EarlyHints: …` When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. - `id: Literal["early_hints"]` ID of the zone setting. - `"early_hints"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEdgeCacheTTL: …` Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. - `id: Literal["edge_cache_ttl"]` ID of the zone setting. - `"edge_cache_ttl"` - `value: Literal[30, 60, 300, 18 more]` Current value of the zone setting. - `30` - `60` - `300` - `1200` - `1800` - `3600` - `7200` - `10800` - `14400` - `18000` - `28800` - `43200` - `57600` - `72000` - `86400` - `172800` - `259200` - `345600` - `432000` - `518400` - `604800` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasEmailObfuscation: …` Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). - `id: Literal["email_obfuscation"]` ID of the zone setting. - `"email_obfuscation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class H2Prioritization: …` HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - `id: Literal["h2_prioritization"]` ID of the zone setting. - `"h2_prioritization"` - `value: Literal["on", "off", "custom"]` Current value of the zone setting. - `"on"` - `"off"` - `"custom"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HotlinkProtection: …` When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). - `id: Literal["hotlink_protection"]` ID of the zone setting. - `"hotlink_protection"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP2: …` HTTP2 enabled for this zone. - `id: Literal["http2"]` ID of the zone setting. - `"http2"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class HTTP3: …` HTTP3 enabled for this zone. - `id: Literal["http3"]` ID of the zone setting. - `"http3"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ImageResizing: …` Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. - `id: Literal["image_resizing"]` ID of the zone setting. - `"image_resizing"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasIPGeolocation: …` Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). - `id: Literal["ip_geolocation"]` ID of the zone setting. - `"ip_geolocation"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class IPV6: …` Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). - `id: Literal["ipv6"]` ID of the zone setting. - `"ipv6"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesMaxUpload: …` Maximum size of an allowable upload. - `id: Literal["max_upload"]` identifier of the zone setting. - `"max_upload"` - `value: Literal[100, 125, 150, 15 more]` Current value of the zone setting. - `100` - `125` - `150` - `175` - `200` - `225` - `250` - `275` - `300` - `325` - `350` - `375` - `400` - `425` - `450` - `475` - `500` - `1000` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class MinTLSVersion: …` Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. - `id: Literal["min_tls_version"]` ID of the zone setting. - `"min_tls_version"` - `value: Literal["1.0", "1.1", "1.2", "1.3"]` Current value of the zone setting. - `"1.0"` - `"1.1"` - `"1.2"` - `"1.3"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasMirage: …` Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. - `id: Literal["mirage"]` ID of the zone setting. - `"mirage"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class NEL: …` Enable Network Error Logging reporting on your zone. (Beta) - `id: Literal["nel"]` Zone setting identifier. - `"nel"` - `value: Value` Current value of the zone setting. - `enabled: Optional[bool]` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOpportunisticEncryption: …` Enables the Opportunistic Encryption feature for a zone. - `id: Literal["opportunistic_encryption"]` ID of the zone setting. - `"opportunistic_encryption"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OpportunisticOnion: …` Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. - `id: Literal["opportunistic_onion"]` ID of the zone setting. - `"opportunistic_onion"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class OrangeToOrange: …` Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - `id: Literal["orange_to_orange"]` ID of the zone setting. - `"orange_to_orange"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasOriginErrorPagePassThru: …` Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. - `id: Literal["origin_error_page_pass_thru"]` ID of the zone setting. - `"origin_error_page_pass_thru"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesCacheRulesOriginH2MaxStreams: …` Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. - `id: Literal["origin_h2_max_streams"]` Value of the zone setting. - `"origin_h2_max_streams"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[int]` Value of the Origin H2 Max Streams Setting. - `class ZonesCacheRulesOriginMaxHTTPVersion: …` Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except Enterprise where it is "1". - `id: Literal["origin_max_http_version"]` Value of the zone setting. - `"origin_max_http_version"` - `modified_on: Optional[datetime]` Last time this setting was modified. - `value: Optional[Literal["2", "1"]]` Value of the Origin Max HTTP Version Setting. - `"2"` - `"1"` - `class ZonesSchemasPolish: …` Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. - `id: Literal["polish"]` ID of the zone setting. - `"polish"` - `value: Literal["off", "lossless", "lossy"]` Current value of the zone setting. - `"off"` - `"lossless"` - `"lossy"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PrefetchPreload: …` Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - `id: Literal["prefetch_preload"]` ID of the zone setting. - `"prefetch_preload"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesPrivacyPass: …` Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). - `id: Literal["privacy_pass"]` ID of the zone setting. - `"privacy_pass"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ProxyReadTimeout: …` Maximum time between two read operations from origin. - `id: Literal["proxy_read_timeout"]` ID of the zone setting. - `"proxy_read_timeout"` - `value: float` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class PseudoIPV4: …` The value set for the Pseudo IPv4 setting. - `id: Literal["pseudo_ipv4"]` Value of the Pseudo IPv4 setting. - `"pseudo_ipv4"` - `value: Literal["off", "add_header", "overwrite_header"]` Current value of the zone setting. - `"off"` - `"add_header"` - `"overwrite_header"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesRedirectsForAITraining: …` When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. - `id: Literal["redirects_for_ai_training"]` ID of the zone setting. - `"redirects_for_ai_training"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesReplaceInsecureJS: …` Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. - `id: Literal["replace_insecure_js"]` ID of the zone setting. - `"replace_insecure_js"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasResponseBuffering: …` Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. - `id: Literal["response_buffering"]` ID of the zone setting. - `"response_buffering"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasRocketLoader: …` Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. - `id: Literal["rocket_loader"]` ID of the zone setting. - `"rocket_loader"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasAutomaticPlatformOptimization: …` [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. - `id: Literal["automatic_platform_optimization"]` ID of the zone setting. - `"automatic_platform_optimization"` - `value: AutomaticPlatformOptimization` Current value of the zone setting. - `cache_by_device_type: bool` Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. - `cf: bool` Indicates whether or not Cloudflare proxy is enabled. - `enabled: bool` Indicates whether or not Automatic Platform Optimization is enabled. - `hostnames: List[str]` An array of hostnames where Automatic Platform Optimization for WordPress is activated. - `wordpress: bool` Indicates whether or not site is powered by WordPress. - `wp_plugin: bool` Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SecurityHeaders: …` Cloudflare security header for a zone. - `id: Literal["security_header"]` ID of the zone's security header. - `"security_header"` - `value: Value` Current value of the zone setting. - `strict_transport_security: Optional[ValueStrictTransportSecurity]` Strict Transport Security. - `enabled: Optional[bool]` Whether or not strict transport security is enabled. - `include_subdomains: Optional[bool]` Include all subdomains for strict transport security. - `max_age: Optional[float]` Max age in seconds of the strict transport security. - `nosniff: Optional[bool]` Whether or not to include 'X-Content-Type-Options: nosniff' header. - `preload: Optional[bool]` Enable automatic preload of the HSTS configuration. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSecurityLevel: …` Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). - `id: Literal["security_level"]` ID of the zone setting. - `"security_level"` - `value: Literal["off", "essentially_off", "low", 3 more]` Current value of the zone setting. - `"off"` - `"essentially_off"` - `"low"` - `"medium"` - `"high"` - `"under_attack"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ServerSideExcludes: …` If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). - `id: Literal["server_side_exclude"]` ID of the zone setting. - `"server_side_exclude"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSha1Support: …` Allow SHA1 support. - `id: Literal["sha1_support"]` Zone setting identifier. - `"sha1_support"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSortQueryStringForCache: …` Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. - `id: Literal["sort_query_string_for_cache"]` ID of the zone setting. - `"sort_query_string_for_cache"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasSSL: …` SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). - `id: Literal["ssl"]` ID of the zone setting. - `"ssl"` - `value: Literal["off", "flexible", "full", "strict"]` Current value of the zone setting. - `"off"` - `"flexible"` - `"full"` - `"strict"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class SSLRecommender: …` Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - `id: Optional[Literal["ssl_recommender"]]` Enrollment value for SSL/TLS Recommender. - `"ssl_recommender"` - `enabled: Optional[bool]` ssl-recommender enrollment setting. - `class ZonesTLS1_2Only: …` Only allows TLS1.2. - `id: Literal["tls_1_2_only"]` Zone setting identifier. - `"tls_1_2_only"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLS1_3: …` Enables Crypto TLS 1.3 feature for a zone. - `id: Literal["tls_1_3"]` ID of the zone setting. - `"tls_1_3"` - `value: Literal["on", "off", "zrt"]` Current value of the zone setting. - `"on"` - `"off"` - `"zrt"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class TLSClientAuth: …` TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - `id: Literal["tls_client_auth"]` ID of the zone setting. - `"tls_client_auth"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformations: …` Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations"` - `value: Literal["on", "off", "open"]` Current value of the zone setting. - `"on"` - `"off"` - `"open"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesTransformationsAllowedOrigins: …` Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. - `id: Literal["transformations_allowed_origins"]` ID of the zone setting. Shared between Image Transformations and Video Transformations. - `"transformations_allowed_origins"` - `value: str` Current value of the zone setting. - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasTrueClientIPHeader: …` Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - `id: Literal["true_client_ip_header"]` ID of the zone setting. - `"true_client_ip_header"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class ZonesSchemasWAF: …` The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). - `id: Literal["waf"]` ID of the zone setting. - `"waf"` - `value: Literal["on", "off"]` Current value of the zone setting. - `"on"` - `"off"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class WebP: …` When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. - `id: Literal["webp"]` ID of the zone setting. - `"webp"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. - `class Websocket: …` WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). - `id: Literal["websockets"]` ID of the zone setting. - `"websockets"` - `value: Literal["off", "on"]` Current value of the zone setting. - `"off"` - `"on"` - `editable: Optional[Literal[true, false]]` Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - `true` - `false` - `modified_on: Optional[datetime]` last time this setting was modified. # Custom Nameservers ## Get Account Custom Nameserver Related Zone Metadata `zones.custom_nameservers.get(CustomNameserverGetParams**kwargs) -> CustomNameserverGetResponse` **get** `/zones/{zone_id}/custom_ns` Get metadata for account-level custom nameservers on a zone. Deprecated in favor of [Show DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings). ### Parameters - `zone_id: str` Identifier. ### Returns - `class CustomNameserverGetResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `enabled: Optional[bool]` Whether zone uses account-level custom nameservers. - `ns_set: Optional[float]` The number of the name server set to assign to the zone. - `result_info: Optional[ResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) custom_nameserver = client.zones.custom_nameservers.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(custom_nameserver.errors) ``` #### Response ```json { "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, "enabled": true, "ns_set": 1, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ## Set Account Custom Nameserver Related Zone Metadata `zones.custom_nameservers.update(CustomNameserverUpdateParams**kwargs) -> SyncSinglePage[CustomNameserverUpdateResponse]` **put** `/zones/{zone_id}/custom_ns` Set metadata for account-level custom nameservers on a zone. If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true. Deprecated in favor of [Update DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-update-dns-settings). ### Parameters - `zone_id: str` Identifier. - `enabled: Optional[bool]` Whether zone uses account-level custom nameservers. - `ns_set: Optional[float]` The number of the name server set to assign to the zone. ### Returns - `str` Unused ### Example ```python 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.custom_nameservers.update( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page) ``` #### Response ```json { "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": [], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ## Domain Types ### Custom Nameserver Get Response - `class CustomNameserverGetResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` - `enabled: Optional[bool]` Whether zone uses account-level custom nameservers. - `ns_set: Optional[float]` The number of the name server set to assign to the zone. - `result_info: Optional[ResultInfo]` - `count: Optional[float]` Total number of results for the requested service. - `page: Optional[float]` Current page within paginated list of results. - `per_page: Optional[float]` Number of results per page of results. - `total_count: Optional[float]` Total results available without any search parameters. ### Custom Nameserver Update Response - `str` Unused # Holds ## Get Zone Hold `zones.holds.get(HoldGetParams**kwargs) -> ZoneHold` **get** `/zones/{zone_id}/hold` Retrieve whether the zone is subject to a zone hold, and metadata about the hold. ### Parameters - `zone_id: str` Identifier. ### Returns - `class ZoneHold: …` - `hold: Optional[bool]` - `hold_after: Optional[str]` - `include_subdomains: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone_hold = client.zones.holds.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone_hold.hold) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "hold": true, "hold_after": "2023-01-31T15:56:36+00:00", "include_subdomains": "include_subdomains" }, "success": true } ``` ## Create Zone Hold `zones.holds.create(HoldCreateParams**kwargs) -> ZoneHold` **post** `/zones/{zone_id}/hold` Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname. ### Parameters - `zone_id: str` Identifier. - `include_subdomains: Optional[bool]` If provided, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc. ### Returns - `class ZoneHold: …` - `hold: Optional[bool]` - `hold_after: Optional[str]` - `include_subdomains: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone_hold = client.zones.holds.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone_hold.hold) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "hold": true, "hold_after": "2023-01-31T15:56:36+00:00", "include_subdomains": "include_subdomains" }, "success": true } ``` ## Update Zone Hold `zones.holds.edit(HoldEditParams**kwargs) -> ZoneHold` **patch** `/zones/{zone_id}/hold` Update the `hold_after` and/or `include_subdomains` values on an existing zone hold. The hold is enabled if the `hold_after` date-time value is in the past. ### Parameters - `zone_id: str` Identifier. - `hold_after: Optional[str]` If `hold_after` is provided and future-dated, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. A past-dated `hold_after` value will have no effect on an existing, enabled hold. Providing an empty string will set its value to the current time. - `include_subdomains: Optional[bool]` If `true`, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc. ### Returns - `class ZoneHold: …` - `hold: Optional[bool]` - `hold_after: Optional[str]` - `include_subdomains: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone_hold = client.zones.holds.edit( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone_hold.hold) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "hold": true, "hold_after": "2023-01-31T15:56:36+00:00", "include_subdomains": "include_subdomains" }, "success": true } ``` ## Remove Zone Hold `zones.holds.delete(HoldDeleteParams**kwargs) -> ZoneHold` **delete** `/zones/{zone_id}/hold` Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname. ### Parameters - `zone_id: str` Identifier. - `hold_after: Optional[str]` If `hold_after` is provided, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely. ### Returns - `class ZoneHold: …` - `hold: Optional[bool]` - `hold_after: Optional[str]` - `include_subdomains: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) zone_hold = client.zones.holds.delete( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(zone_hold.hold) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "hold": true, "hold_after": "2023-01-31T15:56:36+00:00", "include_subdomains": "include_subdomains" }, "success": true } ``` ## Domain Types ### Zone Hold - `class ZoneHold: …` - `hold: Optional[bool]` - `hold_after: Optional[str]` - `include_subdomains: Optional[str]` # Subscriptions ## Zone Subscription Details `zones.subscriptions.get(SubscriptionGetParams**kwargs) -> SubscriptionGetResponse` **get** `/zones/{zone_id}/subscription` Lists zone subscription details. ### Parameters - `zone_id: str` Identifier ### Returns - `class SubscriptionGetResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) subscription = client.zones.subscriptions.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subscription.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "506e3185e9c882d175a2d0cb0093d9f2", "currency": "USD", "current_period_end": "2014-03-31T12:20:00Z", "current_period_start": "2014-05-11T12:20:00Z", "frequency": "monthly", "price": 20, "rate_plan": { "id": "free", "currency": "USD", "externally_managed": false, "is_contract": false, "public_name": "Business Plan", "scope": "zone", "sets": [ "string" ] }, "state": "Paid" }, "success": true } ``` ## Create Zone Subscription `zones.subscriptions.create(SubscriptionCreateParams**kwargs) -> SubscriptionCreateResponse` **post** `/zones/{zone_id}/subscription` Create a zone subscription, either plan or add-ons. ### Parameters - `zone_id: str` Identifier - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. ### Returns - `class SubscriptionCreateResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) subscription = client.zones.subscriptions.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subscription.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "506e3185e9c882d175a2d0cb0093d9f2", "currency": "USD", "current_period_end": "2014-03-31T12:20:00Z", "current_period_start": "2014-05-11T12:20:00Z", "frequency": "monthly", "price": 20, "rate_plan": { "id": "free", "currency": "USD", "externally_managed": false, "is_contract": false, "public_name": "Business Plan", "scope": "zone", "sets": [ "string" ] }, "state": "Paid" }, "success": true } ``` ## Update Zone Subscription `zones.subscriptions.update(SubscriptionUpdateParams**kwargs) -> SubscriptionUpdateResponse` **put** `/zones/{zone_id}/subscription` Updates zone subscriptions, either plan or add-ons. ### Parameters - `zone_id: str` Identifier - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. ### Returns - `class SubscriptionUpdateResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) subscription = client.zones.subscriptions.update( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(subscription.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "506e3185e9c882d175a2d0cb0093d9f2", "currency": "USD", "current_period_end": "2014-03-31T12:20:00Z", "current_period_start": "2014-05-11T12:20:00Z", "frequency": "monthly", "price": 20, "rate_plan": { "id": "free", "currency": "USD", "externally_managed": false, "is_contract": false, "public_name": "Business Plan", "scope": "zone", "sets": [ "string" ] }, "state": "Paid" }, "success": true } ``` ## Domain Types ### Subscription Get Response - `class SubscriptionGetResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Subscription Create Response - `class SubscriptionCreateResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` ### Subscription Update Response - `class SubscriptionUpdateResponse: …` - `id: Optional[str]` Subscription identifier tag. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `current_period_end: Optional[datetime]` The end of the current period and also when the next billing is due. - `current_period_start: Optional[datetime]` When the current billing period started. May match initial_period_start if this is the first period. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", 2 more]]` How often the subscription is renewed automatically. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `"not-applicable"` - `price: Optional[float]` The price of the subscription that will be billed, in US dollars. - `rate_plan: Optional[RatePlan]` The rate plan applied to the subscription. - `id: Optional[Literal["free", "lite", "pro", 7 more]]` The ID of the rate plan. - `"free"` - `"lite"` - `"pro"` - `"pro_plus"` - `"business"` - `"enterprise"` - `"partners_free"` - `"partners_pro"` - `"partners_business"` - `"partners_enterprise"` - `currency: Optional[str]` The currency applied to the rate plan subscription. - `externally_managed: Optional[bool]` Whether this rate plan is managed externally from Cloudflare. - `is_contract: Optional[bool]` Whether a rate plan is enterprise-based (or newly adopted term contract). - `public_name: Optional[str]` The full name of the rate plan. - `scope: Optional[str]` The scope that this rate plan applies to. - `sets: Optional[List[str]]` The list of sets this rate plan applies to. Returns array of strings. - `state: Optional[Literal["Trial", "Provisioned", "Paid", 4 more]]` The state that the subscription is in. - `"Trial"` - `"Provisioned"` - `"Paid"` - `"AwaitingPayment"` - `"Cancelled"` - `"Failed"` - `"Expired"` # Plans ## List Available Plans `zones.plans.list(PlanListParams**kwargs) -> SyncSinglePage[AvailableRatePlan]` **get** `/zones/{zone_id}/available_plans` Lists available plans the zone can subscribe to. ### Parameters - `zone_id: str` Identifier ### Returns - `class AvailableRatePlan: …` - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` Indicates whether you can subscribe to this plan. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `externally_managed: Optional[bool]` Indicates whether this plan is managed externally. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` The frequency at which you will be billed for this plan. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `is_subscribed: Optional[bool]` Indicates whether you are currently subscribed to this plan. - `legacy_discount: Optional[bool]` Indicates whether this plan has a legacy discount applied. - `legacy_id: Optional[str]` The legacy identifier for this rate plan, if any. - `name: Optional[str]` The plan name. - `price: Optional[float]` The amount you will be billed for this plan. ### Example ```python 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.plans.list( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "can_subscribe": true, "currency": "USD", "externally_managed": false, "frequency": "monthly", "is_subscribed": false, "legacy_discount": false, "legacy_id": "free", "name": "Free Plan", "price": 0 } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ## Available Plan Details `zones.plans.get(strplan_identifier, PlanGetParams**kwargs) -> AvailableRatePlan` **get** `/zones/{zone_id}/available_plans/{plan_identifier}` Details of the available plan that the zone can subscribe to. ### Parameters - `zone_id: str` Identifier - `plan_identifier: str` Identifier ### Returns - `class AvailableRatePlan: …` - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` Indicates whether you can subscribe to this plan. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `externally_managed: Optional[bool]` Indicates whether this plan is managed externally. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` The frequency at which you will be billed for this plan. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `is_subscribed: Optional[bool]` Indicates whether you are currently subscribed to this plan. - `legacy_discount: Optional[bool]` Indicates whether this plan has a legacy discount applied. - `legacy_id: Optional[str]` The legacy identifier for this rate plan, if any. - `name: Optional[str]` The plan name. - `price: Optional[float]` The amount you will be billed for this plan. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) available_rate_plan = client.zones.plans.get( plan_identifier="023e105f4ecef8ad9ca31a8372d0c353", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(available_rate_plan.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "can_subscribe": true, "currency": "USD", "externally_managed": false, "frequency": "monthly", "is_subscribed": false, "legacy_discount": false, "legacy_id": "free", "name": "Free Plan", "price": 0 }, "success": true } ``` ## Domain Types ### Available Rate Plan - `class AvailableRatePlan: …` - `id: Optional[str]` Identifier - `can_subscribe: Optional[bool]` Indicates whether you can subscribe to this plan. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `externally_managed: Optional[bool]` Indicates whether this plan is managed externally. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` The frequency at which you will be billed for this plan. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `is_subscribed: Optional[bool]` Indicates whether you are currently subscribed to this plan. - `legacy_discount: Optional[bool]` Indicates whether this plan has a legacy discount applied. - `legacy_id: Optional[str]` The legacy identifier for this rate plan, if any. - `name: Optional[str]` The plan name. - `price: Optional[float]` The amount you will be billed for this plan. # Rate Plans ## List Available Rate Plans `zones.rate_plans.get(RatePlanGetParams**kwargs) -> SyncSinglePage[RatePlanGetResponse]` **get** `/zones/{zone_id}/available_rate_plans` Lists all rate plans the zone can subscribe to. ### Parameters - `zone_id: str` Identifier ### Returns - `class RatePlanGetResponse: …` - `id: Optional[str]` Plan identifier tag. - `components: Optional[List[Component]]` Array of available components values for the plan. - `default: Optional[float]` The default amount allocated. - `name: Optional[Literal["zones", "page_rules", "dedicated_certificates", "dedicated_certificates_custom"]]` The unique component. - `"zones"` - `"page_rules"` - `"dedicated_certificates"` - `"dedicated_certificates_custom"` - `unit_price: Optional[float]` The unit price of the addon. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `duration: Optional[float]` The duration of the plan subscription. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` The frequency at which you will be billed for this plan. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `name: Optional[str]` The plan name. ### Example ```python 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.rate_plans.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "free", "components": [ { "default": 5, "name": "page_rules", "unit_price": 1 } ], "currency": "USD", "duration": 1, "frequency": "monthly", "name": "Free Plan" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ## Domain Types ### Rate Plan Get Response - `class RatePlanGetResponse: …` - `id: Optional[str]` Plan identifier tag. - `components: Optional[List[Component]]` Array of available components values for the plan. - `default: Optional[float]` The default amount allocated. - `name: Optional[Literal["zones", "page_rules", "dedicated_certificates", "dedicated_certificates_custom"]]` The unique component. - `"zones"` - `"page_rules"` - `"dedicated_certificates"` - `"dedicated_certificates_custom"` - `unit_price: Optional[float]` The unit price of the addon. - `currency: Optional[str]` The monetary unit in which pricing information is displayed. - `duration: Optional[float]` The duration of the plan subscription. - `frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]` The frequency at which you will be billed for this plan. - `"weekly"` - `"monthly"` - `"quarterly"` - `"yearly"` - `name: Optional[str]` The plan name.