---
title: List IP Access rules
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Firewall](https://developers.cloudflare.com/api/resources/firewall)
[Access Rules](https://developers.cloudflare.com/api/resources/firewall/subresources/access_rules)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List IP Access rules
GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules
Fetches IP Access rules of an account or zone. These rules apply to all the zones in the account or zone. You can filter the results using several optional parameters.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Account Firewall Access Rules Write``Account Firewall Access Rules Read`
##### P ath ParametersExpand Collapse
account\_id: optional string
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
zone\_id: optional string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
configuration: optional object {target, value }
target: optional "ip"or "ip\_range"or "asn"or "country"
Defines the target to search in existing rules.
One of the following:
"ip"
Link to this property
"ip\_range"
Link to this property
"asn"
Link to this property
"country"
Link to this property
Link to this property
value: optional string
Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided configuration.target. Notes: You can search for a single IPv4 address, an IP address range with a subnet of ‘/16’ or ‘/24’, or a two-letter ISO-3166-1 alpha-2 country code.
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20configuration%20%3E%20(schema)>)
direction: optional "asc"or "desc"
Defines the direction used to sort returned rules.
One of the following:
"asc"
Link to this property
"desc"
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>)
match: optional "any"or "all"
Defines the search requirements. When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match.
One of the following:
"any"
Link to this property
"all"
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20match%20%3E%20(schema)>)
mode: optional "block"or "challenge"or "whitelist"or 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](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20mode%20%3E%20(schema)>)
notes: optional string
Defines the string to search for in the notes of existing IP Access rules. Notes: For example, the string ‘attack’ would match IP Access rules with notes ‘Attack 26/02’ and ‘Attack 27/02’. The search is case insensitive.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20notes%20%3E%20(schema)>)
order: optional "configuration.target"or "configuration.value"or "mode"
Defines the field used to sort returned rules.
One of the following:
"configuration.target"
Link to this property
"configuration.value"
Link to this property
"mode"
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order%20%3E%20(schema)>)
page: optional number
Defines the requested page within paginated list of results.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>)
per\_page: optional number
Defines the maximum number of results requested.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: array of object {id, allowed\_modes, configuration, 5 more }
id: string
The unique identifier of the IP Access rule.
maxLength32
Link to this property
allowed\_modes: array of "block"or "challenge"or "whitelist"or 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: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 more
The rule configuration.
One of the following:
AccessRuleIPConfiguration object {target, value }
target: optional "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 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
IPV6Configuration object {target, value }
target: optional "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 string
The IPv6 address to match.
Link to this property
Link to this property
AccessRuleCIDRConfiguration object {target, value }
target: optional "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 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
ASNConfiguration object {target, value }
target: optional "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 string
The AS number to match.
Link to this property
Link to this property
CountryConfiguration object {target, value }
target: optional "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 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
Link to this property
mode: "block"or "challenge"or "whitelist"or 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 string
The timestamp of when the rule was created.
formatdate-time
Link to this property
modified\_on: optional string
The timestamp of when the rule was last modified.
formatdate-time
Link to this property
notes: optional string
An informative summary of the rule, typically used as a reminder or explanation.
Link to this property
scope: optional object {id, email, type }
All zones owned by the user will have the rule applied.
id: optional string
Defines an identifier.
maxLength32
Link to this property
email: optional string
The contact email address of the user.
maxLength90
Link to this property
type: optional "user"or "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(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Defines whether the API call was successful.
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, total\_count }
count: optional number
Defines the total number of results for the requested service.
Link to this property
page: optional number
Defines the current page within paginated list of results.
Link to this property
per\_page: optional number
Defines the number of results per page of results.
Link to this property
total\_count: optional number
Defines the total results available without any search parameters.
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List IP Access rules
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/firewall/access_rules/rules \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge",
"managed_challenge"
],
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"mode": "challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"notes": "This rule is enabled because of an event that occurred on date X.",
"scope": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"email": "user@example.com",
"type": "user"
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge",
"managed_challenge"
],
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"mode": "challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"notes": "This rule is enabled because of an event that occurred on date X.",
"scope": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"email": "user@example.com",
"type": "user"
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```