--- title: Page Shield --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Page Shield ##### [Get client-side security settings](https://developers.cloudflare.com/api/typescript/resources/page_shield/methods/get) client.pageShield.get(PageShieldGetParams {zone\_id } params, RequestOptionsoptions?): [PageShieldGetResponse]() {enabled, updated\_at, use\_cloudflare\_reporting\_endpoint, use\_connection\_url\_path } | null GET/zones/{zone\_id}/page\_shield ##### [Update client-side security settings](https://developers.cloudflare.com/api/typescript/resources/page_shield/methods/update) client.pageShield.update(PageShieldUpdateParams {zone\_id, enabled, use\_cloudflare\_reporting\_endpoint, use\_connection\_url\_path } params, RequestOptionsoptions?): [PageShieldUpdateResponse]() {enabled, updated\_at, use\_cloudflare\_reporting\_endpoint, use\_connection\_url\_path } PUT/zones/{zone\_id}/page\_shield ##### ModelsExpand Collapse

PageShieldGetResponse {enabled, updated\_at, use\_cloudflare\_reporting\_endpoint, use\_connection\_url\_path }

enabled: boolean When true, indicates that Client-Side Security is enabled. Link to this property updated\_at: string The timestamp of when Client-Side Security was last updated. Link to this property use\_cloudflare\_reporting\_endpoint: boolean When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script\_monitor/report Link to this property use\_connection\_url\_path: boolean When true, the paths associated with connections URLs will also be analyzed. Link to this property

[Link to this property](<#(resource)%20page_shield%20%3E%20(model)%20page_shield_get_response%20%3E%20(schema)>)

PageShieldUpdateResponse {enabled, updated\_at, use\_cloudflare\_reporting\_endpoint, use\_connection\_url\_path }

[Link to this property](<#(resource)%20page_shield%20%3E%20(model)%20page_shield_update_response%20%3E%20(schema)>) #### Page ShieldPolicies ##### [List content security rules](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/policies/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/policies/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/policies/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/policies/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/policies/methods/delete) 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 Link to this property

action: "allow"| "log"| "add\_reporting\_directives" The action to take if the expression matches

One of the following: "allow" Link to this property "log" Link to this property "add\_reporting\_directives" Link to this property

Link to this property description: string A description for the policy Link to this property enabled: boolean Whether the policy is enabled Link to this property expression: string The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax Link to this property value: string The policy which will be applied Link to this property

[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_list_response%20%3E%20(schema)>)

PolicyGetResponse {id, action, description, 3 more }

id: string Identifier maxLength32 Link to this property

action: "allow"| "log"| "add\_reporting\_directives" The action to take if the expression matches

One of the following: "allow" Link to this property "log" Link to this property "add\_reporting\_directives" Link to this property

[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_get_response%20%3E%20(schema)>)

PolicyCreateResponse {id, action, description, 3 more }

id: string Identifier maxLength32 Link to this property

action: "allow"| "log"| "add\_reporting\_directives" The action to take if the expression matches

One of the following: "allow" Link to this property "log" Link to this property "add\_reporting\_directives" Link to this property

[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_create_response%20%3E%20(schema)>)

PolicyUpdateResponse {id, action, description, 3 more }

id: string Identifier maxLength32 Link to this property

action: "allow"| "log"| "add\_reporting\_directives" The action to take if the expression matches

One of the following: "allow" Link to this property "log" Link to this property "add\_reporting\_directives" Link to this property

[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_update_response%20%3E%20(schema)>) #### Page ShieldConnections ##### [List detected connections](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/connections/methods/list) client.pageShield.connections.list(ConnectionListParams {zone\_id, direction, exclude\_cdn\_cgi, 10 more } params, RequestOptionsoptions?): SinglePage< [ConnectionListResponse]() {id, added\_at, first\_seen\_at, 10 more } > GET/zones/{zone\_id}/page\_shield/connections ##### [Get a detected connection](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/connections/methods/get) client.pageShield.connections.get(stringconnectionID, ConnectionGetParams {zone\_id } params, RequestOptionsoptions?): [ConnectionGetResponse]() {id, added\_at, first\_seen\_at, 10 more } | null GET/zones/{zone\_id}/page\_shield/connections/{connection\_id} ##### ModelsExpand Collapse

ConnectionListResponse {id, added\_at, first\_seen\_at, 10 more }

[Link to this property](<#(resource)%20page_shield.connections%20%3E%20(model)%20connection_list_response%20%3E%20(schema)>)

ConnectionGetResponse {id, added\_at, first\_seen\_at, 10 more }

[Link to this property](<#(resource)%20page_shield.connections%20%3E%20(model)%20connection_get_response%20%3E%20(schema)>) #### Page ShieldScripts ##### [List detected scripts](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/scripts/methods/list) client.pageShield.scripts.list(ScriptListParams {zone\_id, direction, exclude\_cdn\_cgi, 11 more } params, RequestOptionsoptions?): SinglePage< [ScriptListResponse]() {id, added\_at, first\_seen\_at, 18 more } > GET/zones/{zone\_id}/page\_shield/scripts ##### [Get a detected script](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/scripts/methods/get) client.pageShield.scripts.get(stringscriptID, ScriptGetParams {zone\_id } params, RequestOptionsoptions?): [ScriptGetResponse]() {id, added\_at, first\_seen\_at, 19 more } | null GET/zones/{zone\_id}/page\_shield/scripts/{script\_id} ##### ModelsExpand Collapse

ScriptListResponse {id, added\_at, first\_seen\_at, 18 more }

id: string Identifier maxLength32 Link to this property added\_at: string formatdate-time Link to this property first\_seen\_at: string formatdate-time Link to this property host: string Link to this property last\_seen\_at: string formatdate-time Link to this property url: string Link to this property url\_contains\_cdn\_cgi\_path: boolean Link to this property cryptomining\_score?: number| null The cryptomining score of the JavaScript content. maximum99 minimum1 Link to this property Deprecateddataflow\_score?: number| null The dataflow score of the JavaScript content. This field has been deprecated in favour of js\_integrity\_score. maximum99 minimum1 Link to this property domain\_reported\_malicious?: boolean Link to this property fetched\_at?: string| null The timestamp of when the script was last fetched. Link to this property first\_page\_url?: string Link to this property hash?: string| null The computed hash of the analyzed script. maxLength64 minLength64 Link to this property js\_integrity\_score?: number| null The integrity score of the JavaScript content. maximum99 minimum1 Link to this property magecart\_score?: number| null The magecart score of the JavaScript content. maximum99 minimum1 Link to this property malicious\_domain\_categories?: Array<string> Link to this property malicious\_url\_categories?: Array<string> Link to this property malware\_score?: number| null The malware score of the JavaScript content. maximum99 minimum1 Link to this property Deprecatedobfuscation\_score?: number| null The obfuscation score of the JavaScript content. This field has been deprecated in favour of js\_integrity\_score. maximum99 minimum1 Link to this property page\_urls?: Array<string> Link to this property url\_reported\_malicious?: boolean Link to this property

[Link to this property](<#(resource)%20page_shield.scripts%20%3E%20(model)%20script_list_response%20%3E%20(schema)>)

ScriptGetResponse {id, added\_at, first\_seen\_at, 19 more }

versions?: Array<Version>| null

cryptomining\_score?: number| null The cryptomining score of the JavaScript content. maximum99 minimum1 Link to this property Deprecateddataflow\_score?: number| null The dataflow score of the JavaScript content. This field has been deprecated in favour of js\_integrity\_score. maximum99 minimum1 Link to this property fetched\_at?: string| null The timestamp of when the script was last fetched. Link to this property hash?: string| null The computed hash of the analyzed script. maxLength64 minLength64 Link to this property js\_integrity\_score?: number| null The integrity score of the JavaScript content. maximum99 minimum1 Link to this property magecart\_score?: number| null The magecart score of the JavaScript content. maximum99 minimum1 Link to this property malware\_score?: number| null The malware score of the JavaScript content. maximum99 minimum1 Link to this property Deprecatedobfuscation\_score?: number| null The obfuscation score of the JavaScript content. This field has been deprecated in favour of js\_integrity\_score. maximum99 minimum1 Link to this property

Link to this property

[Link to this property](<#(resource)%20page_shield.scripts%20%3E%20(model)%20script_get_response%20%3E%20(schema)>) #### Page ShieldCookies ##### [List detected cookies](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/cookies/methods/list) client.pageShield.cookies.list(CookieListParams {zone\_id, direction, domain, 12 more } params, RequestOptionsoptions?): SinglePage< [CookieListResponse]() {id, first\_seen\_at, host, 11 more } > GET/zones/{zone\_id}/page\_shield/cookies ##### [Get a detected cookie](https://developers.cloudflare.com/api/typescript/resources/page_shield/subresources/cookies/methods/get) client.pageShield.cookies.get(stringcookieID, CookieGetParams {zone\_id } params, RequestOptionsoptions?): [CookieGetResponse]() {id, first\_seen\_at, host, 11 more } | null GET/zones/{zone\_id}/page\_shield/cookies/{cookie\_id} ##### ModelsExpand Collapse

CookieListResponse {id, first\_seen\_at, host, 11 more }

id: string Identifier maxLength32 Link to this property first\_seen\_at: string formatdate-time Link to this property host: string Link to this property last\_seen\_at: string formatdate-time Link to this property name: string Link to this property

type: "first\_party"| "unknown"

One of the following: "first\_party" Link to this property "unknown" Link to this property

Link to this property domain\_attribute?: string Link to this property expires\_attribute?: string formatdate-time Link to this property http\_only\_attribute?: boolean Link to this property max\_age\_attribute?: number Link to this property page\_urls?: Array<string> Link to this property path\_attribute?: string Link to this property

same\_site\_attribute?: "lax"| "strict"| "none"

One of the following: "lax" Link to this property "strict" Link to this property "none" Link to this property

Link to this property secure\_attribute?: boolean Link to this property

[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_list_response%20%3E%20(schema)>)

CookieGetResponse {id, first\_seen\_at, host, 11 more }

type: "first\_party"| "unknown"

One of the following: "first\_party" Link to this property "unknown" Link to this property

same\_site\_attribute?: "lax"| "strict"| "none"

One of the following: "lax" Link to this property "strict" Link to this property "none" Link to this property

Link to this property secure\_attribute?: boolean Link to this property

[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)>)