--- title: Get an IP Access rule --- [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** # Get an IP Access rule client.Firewall.AccessRules.Get(ctx, ruleID, query) (\*[AccessRuleGetResponse](), error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} Fetches the details of an IP Access rule defined. ##### 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 ruleID string Unique identifier for a rule. maxLength32 [Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)
query AccessRuleGetParams AccountID param.Field\[string]Optional The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type AccessRuleGetResponse struct{…} ID string The unique identifier of the IP Access rule. maxLength32 Link to this property
AllowedModes \[]AccessRuleGetResponseAllowedMode The available actions that a rule can apply to a matched request. One of the following: const AccessRuleGetResponseAllowedModeBlock AccessRuleGetResponseAllowedMode = "block" Link to this property const AccessRuleGetResponseAllowedModeChallenge AccessRuleGetResponseAllowedMode = "challenge" Link to this property const AccessRuleGetResponseAllowedModeWhitelist AccessRuleGetResponseAllowedMode = "whitelist" Link to this property const AccessRuleGetResponseAllowedModeJSChallenge AccessRuleGetResponseAllowedMode = "js\_challenge" Link to this property const AccessRuleGetResponseAllowedModeManagedChallenge AccessRuleGetResponseAllowedMode = "managed\_challenge" Link to this property
Link to this property
Configuration AccessRuleGetResponseConfiguration 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
Link to this property
Mode AccessRuleGetResponseMode The action to apply to a matched request. One of the following: const AccessRuleGetResponseModeBlock AccessRuleGetResponseMode = "block" Link to this property const AccessRuleGetResponseModeChallenge AccessRuleGetResponseMode = "challenge" Link to this property const AccessRuleGetResponseModeWhitelist AccessRuleGetResponseMode = "whitelist" Link to this property const AccessRuleGetResponseModeJSChallenge AccessRuleGetResponseMode = "js\_challenge" Link to this property const AccessRuleGetResponseModeManagedChallenge AccessRuleGetResponseMode = "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 AccessRuleGetResponseScopeOptional 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 AccessRuleGetResponseScopeTypeOptional Defines the scope of the rule. One of the following: const AccessRuleGetResponseScopeTypeUser AccessRuleGetResponseScopeType = "user" Link to this property const AccessRuleGetResponseScopeTypeOrganization AccessRuleGetResponseScopeType = "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)%20AccessRuleGetResponse%20%3E%20(schema)>) ### Get an IP Access rule 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"), ) accessRule, err := client.Firewall.AccessRules.Get( context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353", firewall.AccessRuleGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accessRule.ID) } ``` 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 } ``` ##### 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 } ```