Skip to content
Cloudflare API
Start here
API Reference
Firewall

Lockdowns

List Zone Lockdown rules
client.firewall.lockdowns.list(LockdownListParams { zone_id, created_on, description, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<Lockdown { id, configurations, created_on, 4 more } >
GET/zones/{zone_id}/firewall/lockdowns
Get a Zone Lockdown rule
client.firewall.lockdowns.get(stringlockDownsId, LockdownGetParams { zone_id } params, RequestOptionsoptions?): Lockdown { id, configurations, created_on, 4 more }
GET/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
Create a Zone Lockdown rule
client.firewall.lockdowns.create(LockdownCreateParams { zone_id, configurations, urls, 3 more } params, RequestOptionsoptions?): Lockdown { id, configurations, created_on, 4 more }
POST/zones/{zone_id}/firewall/lockdowns
Update a Zone Lockdown rule
client.firewall.lockdowns.update(stringlockDownsId, LockdownUpdateParams { zone_id, configurations, urls } params, RequestOptionsoptions?): Lockdown { id, configurations, created_on, 4 more }
PUT/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
Delete a Zone Lockdown rule
client.firewall.lockdowns.delete(stringlockDownsId, LockdownDeleteParams { zone_id } params, RequestOptionsoptions?): LockdownDeleteResponse { id }
DELETE/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
ModelsExpand Collapse
Configuration = Array<LockdownIPConfiguration { target, value } | LockdownCIDRConfiguration { target, value } >

A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations.

One of the following:
LockdownIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

LockdownCIDRConfiguration { target, value }
target?: "ip_range"

The configuration target. You must set the target to ip_range when specifying an IP address range in the Zone Lockdown rule.

value?: string

The IP address range to match. You can only use prefix lengths /16 and /24.

Lockdown { id, configurations, created_on, 4 more }
id: string

The unique identifier of the Zone Lockdown rule.

maxLength32
configurations: Configuration { , }

A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations.

created_on: string

The timestamp of when the rule was created.

formatdate-time
description: string

An informative summary of the rule.

maxLength1024
modified_on: string

The timestamp of when the rule was last modified.

formatdate-time
paused: boolean

When true, indicates that the rule is currently paused.

urls: Array<LockdownURL>

The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.

LockdownCIDRConfiguration { target, value }
target?: "ip_range"

The configuration target. You must set the target to ip_range when specifying an IP address range in the Zone Lockdown rule.

value?: string

The IP address range to match. You can only use prefix lengths /16 and /24.

LockdownIPConfiguration { target, value }
target?: "ip"

The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule.

value?: string

The IP address to match. This address will be compared to the IP address of incoming requests.

LockdownURL = string
LockdownDeleteResponse { id }
id?: string

The unique identifier of the Zone Lockdown rule.

maxLength32