--- title: Update an IP Access rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Firewall](https://developers.cloudflare.com/api/python/resources/firewall) [Access Rules](https://developers.cloudflare.com/api/python/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 firewall.access\_rules.edit(strrule\_id, AccessRuleEditParams\*\*kwargs) -> [AccessRuleEditResponse]() 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 rule\_id: str 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)>)
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["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\[str] 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
class IPV6Configuration: … target: Optional\[Literal\["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\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["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\[str] 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
class ASNConfiguration: … target: Optional\[Literal\["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\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["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\[str] 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](<#(resource)%20firewall.access_rules%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20configuration%20%3E%20(schema)>)
mode: Literal\["block", "challenge", "whitelist", 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)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20mode%20%3E%20(schema)>) account\_id: Optional\[str] 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)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) zone\_id: Optional\[str] 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)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. [Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20notes%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class AccessRuleEditResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 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: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["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\[str] 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
class IPV6Configuration: … target: Optional\[Literal\["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\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["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\[str] 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
class ASNConfiguration: … target: Optional\[Literal\["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\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["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\[str] 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: Literal\["block", "challenge", "whitelist", 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\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "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(model)%20access_rule_edit_response%20%3E%20(schema)>) ### Update an IP Access rule Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.firewall.access_rules.edit( rule_id="023e105f4ecef8ad9ca31a8372d0c353", configuration={}, mode="challenge", account_id="account_id", ) print(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 } ```