Skip to content
Cloudflare API
Start here
API Reference
Firewall

Access Rules

List IP Access rules
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
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
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
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
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.

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.

AccessRuleIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

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.

value?: string

The AS number to match.

CountryConfiguration { target, value }
target?: "country"

The configuration target. You must set the target to country when specifying a country code in the rule.

value?: string

The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.

IPV6Configuration { target, value }
target?: "ip6"

The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule.

value?: string

The IPv6 address to match.

AccessRuleListResponse { id, allowed_modes, configuration, 5 more }
id: string

The unique identifier of the IP Access rule.

maxLength32
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"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
configuration: AccessRuleIPConfiguration { target, value } | IPV6Configuration { target, value } | AccessRuleCIDRConfiguration { target, value } | 2 more

The rule configuration.

One of the following:
AccessRuleIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

IPV6Configuration { target, value }
target?: "ip6"

The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule.

value?: string

The IPv6 address to match.

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.

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.

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.

value?: string

The AS number to match.

CountryConfiguration { target, value }
target?: "country"

The configuration target. You must set the target to country when specifying a country code in the rule.

value?: string

The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.

mode: "block" | "challenge" | "whitelist" | 2 more

The action to apply to a matched request.

One of the following:
"block"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
created_on?: string

The timestamp of when the rule was created.

formatdate-time
modified_on?: string

The timestamp of when the rule was last modified.

formatdate-time
notes?: string

An informative summary of the rule, typically used as a reminder or explanation.

scope?: Scope { id, email, type }

All zones owned by the user will have the rule applied.

id?: string

Defines an identifier.

maxLength32
email?: string

The contact email address of the user.

maxLength90
type?: "user" | "organization"

Defines the scope of the rule.

One of the following:
"user"
"organization"
AccessRuleGetResponse { id, allowed_modes, configuration, 5 more }
id: string

The unique identifier of the IP Access rule.

maxLength32
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"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
configuration: AccessRuleIPConfiguration { target, value } | IPV6Configuration { target, value } | AccessRuleCIDRConfiguration { target, value } | 2 more

The rule configuration.

One of the following:
AccessRuleIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

IPV6Configuration { target, value }
target?: "ip6"

The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule.

value?: string

The IPv6 address to match.

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.

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.

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.

value?: string

The AS number to match.

CountryConfiguration { target, value }
target?: "country"

The configuration target. You must set the target to country when specifying a country code in the rule.

value?: string

The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.

mode: "block" | "challenge" | "whitelist" | 2 more

The action to apply to a matched request.

One of the following:
"block"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
created_on?: string

The timestamp of when the rule was created.

formatdate-time
modified_on?: string

The timestamp of when the rule was last modified.

formatdate-time
notes?: string

An informative summary of the rule, typically used as a reminder or explanation.

scope?: Scope { id, email, type }

All zones owned by the user will have the rule applied.

id?: string

Defines an identifier.

maxLength32
email?: string

The contact email address of the user.

maxLength90
type?: "user" | "organization"

Defines the scope of the rule.

One of the following:
"user"
"organization"
AccessRuleCreateResponse { id, allowed_modes, configuration, 5 more }
id: string

The unique identifier of the IP Access rule.

maxLength32
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"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
configuration: AccessRuleIPConfiguration { target, value } | IPV6Configuration { target, value } | AccessRuleCIDRConfiguration { target, value } | 2 more

The rule configuration.

One of the following:
AccessRuleIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

IPV6Configuration { target, value }
target?: "ip6"

The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule.

value?: string

The IPv6 address to match.

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.

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.

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.

value?: string

The AS number to match.

CountryConfiguration { target, value }
target?: "country"

The configuration target. You must set the target to country when specifying a country code in the rule.

value?: string

The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.

mode: "block" | "challenge" | "whitelist" | 2 more

The action to apply to a matched request.

One of the following:
"block"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
created_on?: string

The timestamp of when the rule was created.

formatdate-time
modified_on?: string

The timestamp of when the rule was last modified.

formatdate-time
notes?: string

An informative summary of the rule, typically used as a reminder or explanation.

scope?: Scope { id, email, type }

All zones owned by the user will have the rule applied.

id?: string

Defines an identifier.

maxLength32
email?: string

The contact email address of the user.

maxLength90
type?: "user" | "organization"

Defines the scope of the rule.

One of the following:
"user"
"organization"
AccessRuleEditResponse { id, allowed_modes, configuration, 5 more }
id: string

The unique identifier of the IP Access rule.

maxLength32
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"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
configuration: AccessRuleIPConfiguration { target, value } | IPV6Configuration { target, value } | AccessRuleCIDRConfiguration { target, value } | 2 more

The rule configuration.

One of the following:
AccessRuleIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

IPV6Configuration { target, value }
target?: "ip6"

The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule.

value?: string

The IPv6 address to match.

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.

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.

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.

value?: string

The AS number to match.

CountryConfiguration { target, value }
target?: "country"

The configuration target. You must set the target to country when specifying a country code in the rule.

value?: string

The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters.

mode: "block" | "challenge" | "whitelist" | 2 more

The action to apply to a matched request.

One of the following:
"block"
"challenge"
"whitelist"
"js_challenge"
"managed_challenge"
created_on?: string

The timestamp of when the rule was created.

formatdate-time
modified_on?: string

The timestamp of when the rule was last modified.

formatdate-time
notes?: string

An informative summary of the rule, typically used as a reminder or explanation.

scope?: Scope { id, email, type }

All zones owned by the user will have the rule applied.

id?: string

Defines an identifier.

maxLength32
email?: string

The contact email address of the user.

maxLength90
type?: "user" | "organization"

Defines the scope of the rule.

One of the following:
"user"
"organization"
AccessRuleDeleteResponse { id }
id: string

Defines an identifier.

maxLength32