Skip to content
Cloudflare API
Start here
API Reference
Page Shield

Policies

List content security rules
client.pageShield.policies.list(PolicyListParams { zone_id } params, RequestOptionsoptions?): SinglePage<PolicyListResponse { id, action, description, 3 more } >
GET/zones/{zone_id}/page_shield/policies
Get a content security rule
client.pageShield.policies.get(stringpolicyID, PolicyGetParams { zone_id } params, RequestOptionsoptions?): PolicyGetResponse { id, action, description, 3 more } | null
GET/zones/{zone_id}/page_shield/policies/{policy_id}
Create a content security rule
client.pageShield.policies.create(PolicyCreateParams { zone_id, action, description, 3 more } params, RequestOptionsoptions?): PolicyCreateResponse { id, action, description, 3 more } | null
POST/zones/{zone_id}/page_shield/policies
Update a content security rule
client.pageShield.policies.update(stringpolicyID, PolicyUpdateParams { zone_id, action, description, 3 more } params, RequestOptionsoptions?): PolicyUpdateResponse { id, action, description, 3 more } | null
PUT/zones/{zone_id}/page_shield/policies/{policy_id}
Delete a content security rule
client.pageShield.policies.delete(stringpolicyID, PolicyDeleteParams { zone_id } params, RequestOptionsoptions?): void
DELETE/zones/{zone_id}/page_shield/policies/{policy_id}
ModelsExpand Collapse
PolicyListResponse { id, action, description, 3 more }
id: string

Identifier

maxLength32
action: "allow" | "log" | "add_reporting_directives"

The action to take if the expression matches

One of the following:
"allow"
"log"
"add_reporting_directives"
description: string

A description for the policy

enabled: boolean

Whether the policy is enabled

expression: string

The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax

value: string

The policy which will be applied

PolicyGetResponse { id, action, description, 3 more }
id: string

Identifier

maxLength32
action: "allow" | "log" | "add_reporting_directives"

The action to take if the expression matches

One of the following:
"allow"
"log"
"add_reporting_directives"
description: string

A description for the policy

enabled: boolean

Whether the policy is enabled

expression: string

The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax

value: string

The policy which will be applied

PolicyCreateResponse { id, action, description, 3 more }
id: string

Identifier

maxLength32
action: "allow" | "log" | "add_reporting_directives"

The action to take if the expression matches

One of the following:
"allow"
"log"
"add_reporting_directives"
description: string

A description for the policy

enabled: boolean

Whether the policy is enabled

expression: string

The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax

value: string

The policy which will be applied

PolicyUpdateResponse { id, action, description, 3 more }
id: string

Identifier

maxLength32
action: "allow" | "log" | "add_reporting_directives"

The action to take if the expression matches

One of the following:
"allow"
"log"
"add_reporting_directives"
description: string

A description for the policy

enabled: boolean

Whether the policy is enabled

expression: string

The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax

value: string

The policy which will be applied