--- title: List Zone Lockdown rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Firewall](https://developers.cloudflare.com/api/go/resources/firewall) [Lockdowns](https://developers.cloudflare.com/api/go/resources/firewall/subresources/lockdowns) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Zone Lockdown rules client.Firewall.Lockdowns.List(ctx, params) (\*V4PagePaginationArray\[[Lockdown]()], error) 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` ##### ParametersExpand Collapse
params LockdownListParams ZoneID param.Field\[string] Path param: Defines an identifier. maxLength32 Link to this property CreatedOn param.Field\[Time]Optional Query param: The timestamp of when the rule was created. formatdate-time Link to this property Description param.Field\[string]Optional Query param: A string to search for in the description of existing rules. Link to this property DescriptionSearch param.Field\[string]Optional Query param: A string to search for in the description of existing rules. Link to this property IP param.Field\[string]Optional Query param: A single IP address to search for in existing rules. Link to this property IPRangeSearch param.Field\[string]Optional Query param: A single IP address range to search for in existing rules. Link to this property IPSearch param.Field\[string]Optional Query param: A single IP address to search for in existing rules. Link to this property ModifiedOn param.Field\[Time]Optional Query param: The timestamp of when the rule was last modified. formatdate-time Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: 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 Priority param.Field\[float64]Optional Query param: 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 URISearch param.Field\[string]Optional Query param: A single URI to search for in the list of URLs of existing rules. Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Lockdown struct{…} 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:
type LockdownIPConfiguration struct{…} Target LockdownIPConfigurationTargetOptional 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 stringOptional 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
type LockdownCIDRConfiguration struct{…} Target LockdownCIDRConfigurationTargetOptional 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 stringOptional 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 CreatedOn Time 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 ModifiedOn Time The timestamp of when the rule was last modified. formatdate-time Link to this property Paused bool When true, indicates that the rule is currently paused. Link to this property URLs \[]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(model)%20lockdown%20%3E%20(schema)>) ### List Zone Lockdown rules Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/firewall" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Firewall.Lockdowns.List(context.TODO(), firewall.LockdownListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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 } } ```