---
title: Lockdowns
---

[Skip to content](#_top)

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

[Firewall](https://developers.cloudflare.com/api/python/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/python/resources/firewall/subresources/lockdowns/methods/list)

firewall.lockdowns.list(LockdownListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Lockdown](<https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)]

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

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

firewall.lockdowns.get(strlock\_downs\_id, LockdownGetParams\*\*kwargs) -> [Lockdown](<https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)

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

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

firewall.lockdowns.create(LockdownCreateParams\*\*kwargs) -> [Lockdown](<https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)

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

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

firewall.lockdowns.update(strlock\_downs\_id, LockdownUpdateParams\*\*kwargs) -> [Lockdown](<https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)

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

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

firewall.lockdowns.delete(strlock\_downs\_id, LockdownDeleteParams\*\*kwargs) -> [LockdownDeleteResponse](<https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_delete_response%20%3E%20(schema)>)

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

##### ModelsExpand Collapse

<details>

<summary>

List\[ConfigurationItem]

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 <code>ip</code> or <code>ip_range</code> configurations.

</summary>

One of the following:

<details>

<summary>

class LockdownIPConfiguration: …

</summary>

target: Optional\[Literal\["ip"]]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

value: Optional\[str]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)">Link to this property</a>

<details>

<summary>

class LockdownCIDRConfiguration: …

</summary>

target: Optional\[Literal\["ip\_range"]]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

value: Optional\[str]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)">Link to this property</a>

</details>

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20configuration%20%3E%20(schema)>)

<details>

<summary>

class Lockdown: …

</summary>

id: str

The unique identifier of the Zone Lockdown rule.

maxLength32

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

configurations: <a href="https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20configuration%20%3E%20(schema)">Configuration</a>

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 <code>ip</code> or <code>ip_range</code> configurations.

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20configurations">Link to this property</a>

created\_on: datetime

The timestamp of when the rule was created.

formatdate-time

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

description: str

An informative summary of the rule.

maxLength1024

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

modified\_on: datetime

The timestamp of when the rule was last modified.

formatdate-time

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

paused: bool

When true, indicates that the rule is currently paused.

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20paused">Link to this property</a>

urls: List\[<a href="https://developers.cloudflare.com/api/python/resources/firewall#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_url%20%3E%20(schema)">LockdownURL</a>]

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.

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)%20%3E%20(property)%20urls">Link to this property</a>

</details>

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)

<details>

<summary>

class LockdownCIDRConfiguration: …

</summary>

target: Optional\[Literal\["ip\_range"]]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

value: Optional\[str]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)>)

<details>

<summary>

class LockdownIPConfiguration: …

</summary>

target: Optional\[Literal\["ip"]]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

value: Optional\[str]

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

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)>)

str

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_url%20%3E%20(schema)>)

<details>

<summary>

class LockdownDeleteResponse: …

</summary>

id: Optional\[str]

The unique identifier of the Zone Lockdown rule.

maxLength32

<a href="#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_delete_response%20%3E%20(schema)>)