---
title: Lockdowns
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Firewall](https://developers.cloudflare.com/api/typescript/resources/firewall)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Lockdowns

##### [List Zone Lockdown rules](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/lockdowns/methods/list)

client.firewall.lockdowns.list(LockdownListParams { zone\_id, created\_on, description, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<[Lockdown](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%20%3E%20%28schema%29) { id, configurations, created\_on, 4 more } \>

GET/zones/{zone\_id}/firewall/lockdowns

##### [Get a Zone Lockdown rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/lockdowns/methods/get)

client.firewall.lockdowns.get(stringlockDownsID, LockdownGetParams { zone\_id } params, RequestOptionsoptions?): [Lockdown](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%20%3E%20%28schema%29) { id, configurations, created\_on, 4 more } 

GET/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id}

##### [Create a Zone Lockdown rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/lockdowns/methods/create)

client.firewall.lockdowns.create(LockdownCreateParams { zone\_id, configurations, urls, 3 more } params, RequestOptionsoptions?): [Lockdown](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%20%3E%20%28schema%29) { id, configurations, created\_on, 4 more } 

POST/zones/{zone\_id}/firewall/lockdowns

##### [Update a Zone Lockdown rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/lockdowns/methods/update)

client.firewall.lockdowns.update(stringlockDownsID, LockdownUpdateParams { zone\_id, configurations, urls } params, RequestOptionsoptions?): [Lockdown](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%20%3E%20%28schema%29) { id, configurations, created\_on, 4 more } 

PUT/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id}

##### [Delete a Zone Lockdown rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/lockdowns/methods/delete)

client.firewall.lockdowns.delete(stringlockDownsID, LockdownDeleteParams { zone\_id } params, RequestOptionsoptions?): [LockdownDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%5Fdelete%5Fresponse%20%3E%20%28schema%29) { id } 

DELETE/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id}

##### ModelsExpand Collapse 

Configuration \= Array<[LockdownIPConfiguration](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%5Fip%5Fconfiguration%20%3E%20%28schema%29) { target, value } | [LockdownCIDRConfiguration](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%5Fcidr%5Fconfiguration%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20configuration%20%3E%20%28schema%29) { , } 

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](https://developers.cloudflare.com/api/typescript/resources/firewall#%28resource%29%20firewall.lockdowns%20%3E%20%28model%29%20lockdown%5Furl%20%3E%20%28schema%29)\>

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