LogoCloudflare API

Firewall

firewall

Firewall

Access Rules

firewall.access_rules

Methods

Create An IP Access Rule -> Envelope<{ id, allowed_modes, configuration, 5 more... }>
post/{account_or_zone}/{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.

Delete An IP Access Rule -> Envelope<{ id }>
delete/{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules/{rule_id}

Deletes an existing IP Access rule defined.

Note: This operation will affect all zones in the account or zone.

Update An IP Access Rule -> Envelope<{ id, allowed_modes, configuration, 5 more... }>
patch/{account_or_zone}/{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.

Get An IP Access Rule -> Envelope<{ id, allowed_modes, configuration, 5 more... }>
get/{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules/{rule_id}

Fetches the details of an IP Access rule defined.

List IP Access Rules -> V4PagePaginationArray<{ id, allowed_modes, configuration, 5 more... }>
get/{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules

Fetches IP Access rules of an account or zone. These rules apply to all the zones in the account or zone. You can filter the results using several optional parameters.

Domain types

AccessRuleCIDRConfiguration = { target, value }
AccessRuleIPConfiguration = { target, value }
ASNConfiguration = { target, value }
CountryConfiguration = { target, value }
IPV6Configuration = { target, value }
Firewall

Lockdowns

firewall.lockdowns

Methods

Create A Zone Lockdown Rule -> Envelope<
Lockdown
>
post/zones/{zone_id}/firewall/lockdowns

Creates a new Zone Lockdown rule.

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<
Lockdown
>
get/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}

Fetches the details of a Zone Lockdown rule.

List Zone Lockdown Rules -> V4PagePaginationArray<
Lockdown
>
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<
Lockdown
>
put/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}

Updates an existing Zone Lockdown rule.

Domain types

Configuration = Array<
LockdownIPConfiguration
|
LockdownCIDRConfiguration
>
Lockdown = { id, configurations, created_on, 4 more... }
LockdownCIDRConfiguration = { target, value }
LockdownIPConfiguration = { target, value }
LockdownURL = string
Firewall

Rules

firewall.rules

Methods

Delete Firewall Rules -> Envelope<Array<
FirewallRule
>>
Deprecated
delete/zones/{zone_id}/firewall/rules

Deletes existing firewall rules.

Update Priority Of Firewall Rules -> Envelope<Array<
FirewallRule
>>
Deprecated
patch/zones/{zone_id}/firewall/rules

Updates the priority of existing firewall rules.

Update Firewall Rules -> Envelope<Array<
FirewallRule
>>
Deprecated
put/zones/{zone_id}/firewall/rules

Updates one or more existing firewall rules.

Create Firewall Rules -> Envelope<Array<
FirewallRule
>>
Deprecated
post/zones/{zone_id}/firewall/rules

Create one or more firewall rules.

Delete A Firewall Rule -> Envelope<
FirewallRule
>
Deprecated
delete/zones/{zone_id}/firewall/rules/{rule_id}

Deletes an existing firewall rule.

Update Priority Of A Firewall Rule -> Envelope<Array<
FirewallRule
>>
Deprecated
patch/zones/{zone_id}/firewall/rules/{rule_id}

Updates the priority of an existing firewall rule.

Get A Firewall Rule -> Envelope<
FirewallRule
>
Deprecated
get/zones/{zone_id}/firewall/rules/{rule_id}

Fetches the details of a firewall rule.

List Firewall Rules -> V4PagePaginationArray<
FirewallRule
>
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<
FirewallRule
>
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...
Firewall

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.

Firewall

WAF

firewall.waf

FirewallWAF

Overrides

firewall.waf.overrides

Methods

Create A WAF Override -> Envelope<
Override
>
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.

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)

Zone Settings Write

Parameters
zone_id: string

Identifier

overrides_id: string

The unique identifier of the WAF override.

Response fields
result: { id }
Optional
Request example
200Example
Get A WAF Override -> Envelope<
Override
>
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<
Override
>
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<
Override
>
put/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

Updates an existing URI-based WAF override.

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

Domain types

Override = { id, description, groups, 5 more... }
OverrideURL = string
RewriteAction = { block, challenge, default, 2 more... }
WAFRule = Record<string, "challenge" | "block" | "simulate" | 2 more...>
FirewallWAF

Packages

firewall.waf.packages

Methods

Get A WAF Package -> { errors, messages, result, 1 more... } | { result }
get/zones/{zone_id}/firewall/waf/packages/{package_id}

Fetches the details of a WAF package.

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

List WAF Packages -> V4PagePaginationArray<unknown>
get/zones/{zone_id}/firewall/waf/packages

Fetches WAF packages for a zone.

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

FirewallWAFPackages

Groups

firewall.waf.packages.groups

Methods

Update A WAF Rule Group -> Envelope<unknown>
patch/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}

Updates a WAF rule group. You can update the state (mode parameter) of a rule group.

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

Get A WAF Rule Group -> Envelope<unknown>
get/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}

Fetches the details of a WAF rule group.

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

List WAF Rule Groups -> V4PagePaginationArray<
Group
>
get/zones/{zone_id}/firewall/waf/packages/{package_id}/groups

Fetches the WAF rule groups in a WAF package.

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

Domain types

Group = { id, description, mode, 5 more... }
FirewallWAFPackages

Rules

firewall.waf.packages.rules

Methods

Update A WAF Rule -> Envelope<{ id, allowed_modes, description, 4 more... } | { id, allowed_modes, default_mode, 5 more... } | { id, allowed_modes, description, 4 more... }>
patch/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}

Updates a WAF rule. You can only update the mode/action of the rule.

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

Get A WAF Rule -> Envelope<unknown>
get/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}

Fetches the details of a WAF rule in a WAF package.

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

List WAF Rules -> V4PagePaginationArray<{ id, allowed_modes, description, 4 more... } | { id, allowed_modes, default_mode, 5 more... } | { id, allowed_modes, description, 4 more... }>
get/zones/{zone_id}/firewall/waf/packages/{package_id}/rules

Fetches WAF rules in a WAF package.

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

Domain types

AllowedModesAnomaly = "on" | "off"
WAFRuleGroup = { id, name }