--- title: List IP Access rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Firewall](https://developers.cloudflare.com/api/go/resources/firewall) [Access Rules](https://developers.cloudflare.com/api/go/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 client.Firewall.AccessRules.List(ctx, params) (\*V4PagePaginationArray\[[AccessRuleListResponse]()], error) 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` ##### ParametersExpand Collapse

params AccessRuleListParams

AccountID param.Field\[string]Optional Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property

Configuration param.Field\[AccessRuleListParamsConfiguration]Optional Query param

Target AccessRuleListParamsConfigurationTargetOptional Defines the target to search in existing rules.

One of the following: const AccessRuleListParamsConfigurationTargetIP AccessRuleListParamsConfigurationTarget = "ip" Link to this property const AccessRuleListParamsConfigurationTargetIPRange AccessRuleListParamsConfigurationTarget = "ip\_range" Link to this property const AccessRuleListParamsConfigurationTargetASN AccessRuleListParamsConfigurationTarget = "asn" Link to this property const AccessRuleListParamsConfigurationTargetCountry AccessRuleListParamsConfigurationTarget = "country" Link to this property

Link to this property Value stringOptional 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

Direction param.Field\[AccessRuleListParamsDirection]Optional Query param: Defines the direction used to sort returned rules.

const AccessRuleListParamsDirectionAsc AccessRuleListParamsDirection = "asc" Link to this property const AccessRuleListParamsDirectionDesc AccessRuleListParamsDirection = "desc" Link to this property

Link to this property

Match param.Field\[AccessRuleListParamsMatch]Optional Query param: 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.

const AccessRuleListParamsMatchAny AccessRuleListParamsMatch = "any" Link to this property const AccessRuleListParamsMatchAll AccessRuleListParamsMatch = "all" Link to this property

Link to this property

Mode param.Field\[AccessRuleListParamsMode]Optional Query param: The action to apply to a matched request.

const AccessRuleListParamsModeBlock AccessRuleListParamsMode = "block" Link to this property const AccessRuleListParamsModeChallenge AccessRuleListParamsMode = "challenge" Link to this property const AccessRuleListParamsModeWhitelist AccessRuleListParamsMode = "whitelist" Link to this property const AccessRuleListParamsModeJSChallenge AccessRuleListParamsMode = "js\_challenge" Link to this property const AccessRuleListParamsModeManagedChallenge AccessRuleListParamsMode = "managed\_challenge" Link to this property

Link to this property Notes param.Field\[string]Optional Query param: 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

Order param.Field\[AccessRuleListParamsOrder]Optional Query param: Defines the field used to sort returned rules.

const AccessRuleListParamsOrderConfigurationTarget AccessRuleListParamsOrder = "configuration.target" Link to this property const AccessRuleListParamsOrderConfigurationValue AccessRuleListParamsOrder = "configuration.value" Link to this property const AccessRuleListParamsOrderMode AccessRuleListParamsOrder = "mode" Link to this property

Link to this property Page param.Field\[float64]Optional Query param: Defines the requested page within paginated list of results. Link to this property PerPage param.Field\[float64]Optional Query param: Defines the maximum number of results requested. Link to this property

[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type AccessRuleListResponse struct{…}

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

AllowedModes \[]AccessRuleListResponseAllowedMode The available actions that a rule can apply to a matched request.

One of the following: const AccessRuleListResponseAllowedModeBlock AccessRuleListResponseAllowedMode = "block" Link to this property const AccessRuleListResponseAllowedModeChallenge AccessRuleListResponseAllowedMode = "challenge" Link to this property const AccessRuleListResponseAllowedModeWhitelist AccessRuleListResponseAllowedMode = "whitelist" Link to this property const AccessRuleListResponseAllowedModeJSChallenge AccessRuleListResponseAllowedMode = "js\_challenge" Link to this property const AccessRuleListResponseAllowedModeManagedChallenge AccessRuleListResponseAllowedMode = "managed\_challenge" Link to this property

Link to this property

Configuration AccessRuleListResponseConfiguration The rule configuration.

One of the following:

type AccessRuleIPConfiguration struct{…}

Target AccessRuleIPConfigurationTargetOptional The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property Value stringOptional 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

type IPV6Configuration struct{…}

Target IPV6ConfigurationTargetOptional The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property Value stringOptional The IPv6 address to match. Link to this property

Link to this property

type AccessRuleCIDRConfiguration struct{…}

Target AccessRuleCIDRConfigurationTargetOptional 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 stringOptional 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

type ASNConfiguration struct{…}

Target ASNConfigurationTargetOptional 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 stringOptional The AS number to match. Link to this property

Link to this property

type CountryConfiguration struct{…}

Target CountryConfigurationTargetOptional The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property Value stringOptional 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

Mode AccessRuleListResponseMode The action to apply to a matched request.

One of the following: const AccessRuleListResponseModeBlock AccessRuleListResponseMode = "block" Link to this property const AccessRuleListResponseModeChallenge AccessRuleListResponseMode = "challenge" Link to this property const AccessRuleListResponseModeWhitelist AccessRuleListResponseMode = "whitelist" Link to this property const AccessRuleListResponseModeJSChallenge AccessRuleListResponseMode = "js\_challenge" Link to this property const AccessRuleListResponseModeManagedChallenge AccessRuleListResponseMode = "managed\_challenge" Link to this property

Link to this property CreatedOn TimeOptional The timestamp of when the rule was created. formatdate-time Link to this property ModifiedOn TimeOptional The timestamp of when the rule was last modified. formatdate-time Link to this property Notes stringOptional An informative summary of the rule, typically used as a reminder or explanation. Link to this property

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

ID stringOptional Defines an identifier. maxLength32 Link to this property Email stringOptional The contact email address of the user. maxLength90 Link to this property

Type AccessRuleListResponseScopeTypeOptional Defines the scope of the rule.

One of the following: const AccessRuleListResponseScopeTypeUser AccessRuleListResponseScopeType = "user" Link to this property const AccessRuleListResponseScopeTypeOrganization AccessRuleListResponseScopeType = "organization" Link to this property

Link to this property

[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20AccessRuleListResponse%20%3E%20(schema)>) ### List IP Access rules Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/firewall" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Firewall.AccessRules.List(context.TODO(), firewall.AccessRuleListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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 } } ```