---
title: List Zone Lockdown rules
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Firewall](https://developers.cloudflare.com/api/resources/firewall)
[Lockdowns](https://developers.cloudflare.com/api/resources/firewall/subresources/lockdowns)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List Zone Lockdown rules
GET/zones/{zone\_id}/firewall/lockdowns
Fetches Zone Lockdown rules. You can filter the results using several optional parameters.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
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``Firewall Services Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Defines an identifier.
maxLength32
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
created\_on: optional string
The timestamp of when the rule was created.
formatdate-time
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20created_on%20%3E%20(schema)>)
description: optional string
A string to search for in the description of existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20description%20%3E%20(schema)>)
description\_search: optional string
A string to search for in the description of existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20description_search%20%3E%20(schema)>)
ip: optional string
A single IP address to search for in existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20ip%20%3E%20(schema)>)
ip\_range\_search: optional string
A single IP address range to search for in existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20ip_range_search%20%3E%20(schema)>)
ip\_search: optional string
A single IP address to search for in existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20ip_search%20%3E%20(schema)>)
modified\_on: optional string
The timestamp of when the rule was last modified.
formatdate-time
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20modified_on%20%3E%20(schema)>)
page: optional number
Page number of paginated results.
minimum1
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>)
per\_page: optional number
The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.
maximum1000
minimum1
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
priority: optional number
The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20priority%20%3E%20(schema)>)
uri\_search: optional string
A single URI to search for in the list of URLs of existing rules.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20uri_search%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: array of Lockdown { id, configurations, created\_on, 4 more }
id: string
The unique identifier of the Zone Lockdown rule.
maxLength32
Link to this property
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.
One of the following:
LockdownIPConfiguration object {target, value }
target: optional "ip"
The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule.
Link to this property
value: optional string
The IP address to match. This address will be compared to the IP address of incoming requests.
Link to this property
Link to this property
LockdownCIDRConfiguration object {target, value }
target: optional "ip\_range"
The configuration target. You must set the target to ip_range when specifying an IP address range in the Zone Lockdown rule.
Link to this property
value: optional string
The IP address range to match. You can only use prefix lengths /16 and /24.
Link to this property
Link to this property
Link to this property
created\_on: string
The timestamp of when the rule was created.
formatdate-time
Link to this property
description: string
An informative summary of the rule.
maxLength1024
Link to this property
modified\_on: string
The timestamp of when the rule was last modified.
formatdate-time
Link to this property
paused: boolean
When true, indicates that the rule is currently paused.
Link to this property
urls: array of 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.
Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Defines whether the API call was successful.
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, total\_count }
count: optional number
Defines the total number of results for the requested service.
Link to this property
page: optional number
Defines the current page within paginated list of results.
Link to this property
per\_page: optional number
Defines the number of results per page of results.
Link to this property
total\_count: optional number
Defines the total results available without any search parameters.
Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List Zone Lockdown rules
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/firewall/lockdowns \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"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,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"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,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```