--- title: Access Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Firewall](https://developers.cloudflare.com/api/typescript/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/typescript/resources/firewall/subresources/access_rules/methods/list) client.firewall.accessRules.list(AccessRuleListParams {account\_id, zone\_id, configuration, 7 more } params?, RequestOptionsoptions?): V4PagePaginationArray< [AccessRuleListResponse]() {id, allowed\_modes, configuration, 5 more } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Get an IP Access rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/access_rules/methods/get) client.firewall.accessRules.get(stringruleID, AccessRuleGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [AccessRuleGetResponse]() {id, allowed\_modes, configuration, 5 more } GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Create an IP Access rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/access_rules/methods/create) client.firewall.accessRules.create(AccessRuleCreateParams {configuration, mode, account\_id, 2 more } params, RequestOptionsoptions?): [AccessRuleCreateResponse]() {id, allowed\_modes, configuration, 5 more } POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Update an IP Access rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/access_rules/methods/edit) client.firewall.accessRules.edit(stringruleID, AccessRuleEditParams {configuration, mode, account\_id, 2 more } params, RequestOptionsoptions?): [AccessRuleEditResponse]() {id, allowed\_modes, configuration, 5 more } PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Delete an IP Access rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/access_rules/methods/delete) client.firewall.accessRules.delete(stringruleID, AccessRuleDeleteParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [AccessRuleDeleteResponse]() {id } | null DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### ModelsExpand Collapse

AccessRuleCIDRConfiguration {target, value }

target?: "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?: string 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)>)

AccessRuleIPConfiguration {target, value }

target?: "ip" The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value?: string 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)>)

ASNConfiguration {target, value }

target?: "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?: string 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)>)

CountryConfiguration {target, value }

target?: "country" The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value?: string 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)>)

IPV6Configuration {target, value }

target?: "ip6" The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value?: string 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)>)

AccessRuleListResponse {id, allowed\_modes, configuration, 5 more }

id: string The unique identifier of the IP Access rule. maxLength32 Link to this property

allowed\_modes: Array<"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