Skip to content
Cloudflare API
Start here
API Reference
Firewall

Lockdowns

List Zone Lockdown rules
client.Firewall.Lockdowns.List(ctx, params) (*V4PagePaginationArray[Lockdown], error)
GET/zones/{zone_id}/firewall/lockdowns
Get a Zone Lockdown rule
client.Firewall.Lockdowns.Get(ctx, lockDownsID, query) (*Lockdown, error)
GET/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
Create a Zone Lockdown rule
client.Firewall.Lockdowns.New(ctx, params) (*Lockdown, error)
POST/zones/{zone_id}/firewall/lockdowns
Update a Zone Lockdown rule
client.Firewall.Lockdowns.Update(ctx, lockDownsID, params) (*Lockdown, error)
PUT/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
Delete a Zone Lockdown rule
client.Firewall.Lockdowns.Delete(ctx, lockDownsID, body) (*LockdownDeleteResponse, error)
DELETE/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}
ModelsExpand Collapse
type Configuration []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 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.

Value stringoptional

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

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.

Value stringoptional

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

type Lockdown struct{…}
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.

CreatedOn Time

The timestamp of when the rule was created.

formatdate-time
Description string

An informative summary of the rule.

maxLength1024
ModifiedOn Time

The timestamp of when the rule was last modified.

formatdate-time
Paused bool

When true, indicates that the rule is currently paused.

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.

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.

Value stringoptional

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

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.

Value stringoptional

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

type LockdownURL string