Create an IP Access rule
firewall.access_rules.create(AccessRuleCreateParams**kwargs) -> AccessRuleCreateResponse
POST/{accounts_or_zones}/{account_or_zone_id}/firewall/access_rules/rules
Creates a new IP Access rule for an account or zone. The rule will apply to all zones in the account or zone.
Note: To create an IP Access rule that applies to a single zone, refer to the IP Access rules for a zone endpoints.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Create an IP Access rule
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
access_rule = client.firewall.access_rules.create(
configuration={},
mode="challenge",
account_id="account_id",
)
print(access_rule.id){
"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
{
"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
}