Cloudflare API | Firewall › Lockdowns › Create A Zone Lockdown Rule

Lockdowns

firewall.lockdowns

Methods

Create A Zone Lockdown Rule -> Envelope<

post/zones/{zone_id}/firewall/lockdowns

Creates a new Zone Lockdown rule.

Security

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)

Firewall Services Write

Parameters

zone_id: string

Identifier

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

result:

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/firewall/lockdowns \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "configurations": [
        {}
      ],
      "urls": [
        "shop.example.com/*"
      ]
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "configurations": [
      {
        "target": "ip",
        "value": "198.51.100.4"
      }
    ],
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Restrict access to these endpoints to requests from a known IP address",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "paused": false,
    "urls": [
      "api.mysite.com/some/endpoint*"
    ]
  },
  "success": true
}

Delete A Zone Lockdown Rule -> Envelope<{ id }>

delete/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}

Deletes an existing Zone Lockdown rule.

Get A Zone Lockdown Rule -> Envelope<

get/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}

Fetches the details of a Zone Lockdown rule.

List Zone Lockdown Rules -> V4PagePaginationArray<

get/zones/{zone_id}/firewall/lockdowns

Fetches Zone Lockdown rules. You can filter the results using several optional parameters.

Update A Zone Lockdown Rule -> Envelope<

LockdownCIDRConfiguration

put/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}

Updates an existing Zone Lockdown rule.

Domain types

Configuration = Array<

LockdownIPConfiguration

Lockdown = { id, configurations, created_on, 4 more... }

LockdownCIDRConfiguration = { target, value }

LockdownIPConfiguration = { target, value }

LockdownURL = string

Rules

firewall.rules

Methods

Delete Firewall Rules -> Envelope<Array<

Deprecated

delete/zones/{zone_id}/firewall/rules

Deletes existing firewall rules.

Update Priority Of Firewall Rules -> Envelope<Array<

Deprecated

patch/zones/{zone_id}/firewall/rules

Updates the priority of existing firewall rules.

Update Firewall Rules -> Envelope<Array<

Deprecated

put/zones/{zone_id}/firewall/rules

Updates one or more existing firewall rules.

Create Firewall Rules -> Envelope<Array<

Deprecated

post/zones/{zone_id}/firewall/rules

Create one or more firewall rules.

Delete A Firewall Rule -> Envelope<

Deprecated

delete/zones/{zone_id}/firewall/rules/{rule_id}

Deletes an existing firewall rule.

Update Priority Of A Firewall Rule -> Envelope<Array<

Deprecated

patch/zones/{zone_id}/firewall/rules/{rule_id}

Updates the priority of an existing firewall rule.

Get A Firewall Rule -> Envelope<

Deprecated

get/zones/{zone_id}/firewall/rules/{rule_id}

Fetches the details of a firewall rule.

List Firewall Rules -> V4PagePaginationArray<

Deprecated

get/zones/{zone_id}/firewall/rules

Fetches firewall rules in a zone. You can filter the results using several optional parameters.

Update A Firewall Rule -> Envelope<

Deprecated

put/zones/{zone_id}/firewall/rules/{rule_id}

Updates an existing firewall rule.

Domain types

DeletedFilter = { id, deleted }

FirewallRule = { id, action, description, 5 more... }

Product = "zoneLockdown" | "uaBlock" | "bic" | 4 more...

UA Rules

firewall.ua_rules

Methods

Create A User Agent Blocking Rule -> Envelope<unknown>

post/zones/{zone_id}/firewall/ua_rules

Creates a new User Agent Blocking rule in a zone.

Delete A User Agent Blocking Rule -> Envelope<{ id }>

delete/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

Deletes an existing User Agent Blocking rule.

Get A User Agent Blocking Rule -> Envelope<unknown>

get/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

Fetches the details of a User Agent Blocking rule.

List User Agent Blocking Rules -> V4PagePaginationArray<{ id, configuration, description, 2 more... }>

get/zones/{zone_id}/firewall/ua_rules

Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.

Update A User Agent Blocking Rule -> Envelope<unknown>

put/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

Updates an existing User Agent Blocking rule.

WAF

firewall.waf

Firewall WAF

Overrides

firewall.waf.overrides

Methods

Create A WAF Override -> Envelope<

post/zones/{zone_id}/firewall/waf/overrides

Creates a URI-based WAF override for a zone.

Note: Applies only to the previous version of WAF managed rules.

Delete A WAF Override -> Envelope<{ id }>

delete/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

Deletes an existing URI-based WAF override.

Note: Applies only to the previous version of WAF managed rules.

Get A WAF Override -> Envelope<

get/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

Fetches the details of a URI-based WAF override.

Note: Applies only to the previous version of WAF managed rules.

List WAF Overrides -> V4PagePaginationArray<

get/zones/{zone_id}/firewall/waf/overrides

Fetches the URI-based WAF overrides in a zone.

Note: Applies only to the previous version of WAF managed rules.

Update WAF Override -> Envelope<