--- title: Access Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Firewall](https://developers.cloudflare.com/api/python/resources/firewall) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Access Rules ##### [List IP Access rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/list) firewall.access\_rules.list(AccessRuleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[AccessRuleListResponse]()] GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Get an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/get) firewall.access\_rules.get(strrule\_id, AccessRuleGetParams\*\*kwargs) -> [AccessRuleGetResponse]() GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Create an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/create) firewall.access\_rules.create(AccessRuleCreateParams\*\*kwargs) -> [AccessRuleCreateResponse]() POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Update an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/edit) firewall.access\_rules.edit(strrule\_id, AccessRuleEditParams\*\*kwargs) -> [AccessRuleEditResponse]() PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Delete an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/delete) firewall.access\_rules.delete(strrule\_id, AccessRuleDeleteParams\*\*kwargs) -> [AccessRuleDeleteResponse]() DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### ModelsExpand Collapse
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_cidr_configuration%20%3E%20(schema)>)
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_ip_configuration%20%3E%20(schema)>)
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20asn_configuration%20%3E%20(schema)>)
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20country_configuration%20%3E%20(schema)>)
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20ipv6_configuration%20%3E%20(schema)>)
class AccessRuleListResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_list_response%20%3E%20(schema)>)
class AccessRuleGetResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_get_response%20%3E%20(schema)>)
class AccessRuleCreateResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_create_response%20%3E%20(schema)>)
class AccessRuleEditResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_edit_response%20%3E%20(schema)>)
class AccessRuleDeleteResponse: … id: str Defines an identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_delete_response%20%3E%20(schema)>)