--- title: Update 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** # Update an IP Access rule client.Firewall.AccessRules.Edit(ctx, ruleID, params) (\*[AccessRuleEditResponse](), error) PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} Updates an IP Access rule defined. Note: This operation will affect all zones in the account or zone. ##### 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` ##### ParametersExpand Collapse ruleID string Unique identifier for a rule. maxLength32 [Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)

params AccessRuleEditParams

Configuration param.Field\[AccessRuleEditParamsConfiguration] Body param: The rule configuration.

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 param.Field\[AccessRuleEditParamsMode] Body param: The action to apply to a matched request.

const AccessRuleEditParamsModeBlock AccessRuleEditParamsMode = "block" Link to this property const AccessRuleEditParamsModeChallenge AccessRuleEditParamsMode = "challenge" Link to this property const AccessRuleEditParamsModeWhitelist AccessRuleEditParamsMode = "whitelist" Link to this property const AccessRuleEditParamsModeJSChallenge AccessRuleEditParamsMode = "js\_challenge" Link to this property const AccessRuleEditParamsModeManagedChallenge AccessRuleEditParamsMode = "managed\_challenge" Link to this property

Link to this property 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 Notes param.Field\[string]Optional Body param: An informative summary of the rule, typically used as a reminder or explanation. Link to this property

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

type AccessRuleEditResponse struct{…}

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

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

One of the following: const AccessRuleEditResponseAllowedModeBlock AccessRuleEditResponseAllowedMode = "block" Link to this property const AccessRuleEditResponseAllowedModeChallenge AccessRuleEditResponseAllowedMode = "challenge" Link to this property const AccessRuleEditResponseAllowedModeWhitelist AccessRuleEditResponseAllowedMode = "whitelist" Link to this property const AccessRuleEditResponseAllowedModeJSChallenge AccessRuleEditResponseAllowedMode = "js\_challenge" Link to this property const AccessRuleEditResponseAllowedModeManagedChallenge AccessRuleEditResponseAllowedMode = "managed\_challenge" Link to this property

Link to this property

Configuration AccessRuleEditResponseConfiguration The rule configuration.

One of the following:

type AccessRuleIPConfiguration struct{…}

Link to this property

type IPV6Configuration struct{…}

Link to this property

type AccessRuleCIDRConfiguration struct{…}

Link to this property

type ASNConfiguration struct{…}

Link to this property

type CountryConfiguration struct{…}

Link to this property

Mode AccessRuleEditResponseMode The action to apply to a matched request.

One of the following: const AccessRuleEditResponseModeBlock AccessRuleEditResponseMode = "block" Link to this property const AccessRuleEditResponseModeChallenge AccessRuleEditResponseMode = "challenge" Link to this property const AccessRuleEditResponseModeWhitelist AccessRuleEditResponseMode = "whitelist" Link to this property const AccessRuleEditResponseModeJSChallenge AccessRuleEditResponseMode = "js\_challenge" Link to this property const AccessRuleEditResponseModeManagedChallenge AccessRuleEditResponseMode = "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 AccessRuleEditResponseScopeOptional 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 AccessRuleEditResponseScopeTypeOptional Defines the scope of the rule.

One of the following: const AccessRuleEditResponseScopeTypeUser AccessRuleEditResponseScopeType = "user" Link to this property const AccessRuleEditResponseScopeTypeOrganization AccessRuleEditResponseScopeType = "organization" Link to this property

Link to this property

[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20AccessRuleEditResponse%20%3E%20(schema)>) ### Update 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"), ) response, err := client.Firewall.AccessRules.Edit( context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353", firewall.AccessRuleEditParams{ Configuration: cloudflare.F[firewall.AccessRuleEditParamsConfigurationUnion](firewall.AccessRuleIPConfigurationParam{ }), Mode: cloudflare.F(firewall.AccessRuleEditParamsModeChallenge), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.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 } ```