--- title: Page Shield --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) 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/python/resources/page_shield/methods/get) page\_shield.get(PageShieldGetParams\*\*kwargs) -> [PageShieldGetResponse]() GET/zones/{zone\_id}/page\_shield ##### [Update client-side security settings](https://developers.cloudflare.com/api/python/resources/page_shield/methods/update) page\_shield.update(PageShieldUpdateParams\*\*kwargs) -> [PageShieldUpdateResponse]() PUT/zones/{zone\_id}/page\_shield ##### ModelsExpand Collapse
class PageShieldGetResponse: … enabled: bool When true, indicates that Client-Side Security is enabled. Link to this property updated\_at: str The timestamp of when Client-Side Security was last updated. Link to this property use\_cloudflare\_reporting\_endpoint: bool 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: bool 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)>)
class PageShieldUpdateResponse: … enabled: bool When true, indicates that Client-Side Security is enabled. Link to this property updated\_at: str The timestamp of when Client-Side Security was last updated. Link to this property use\_cloudflare\_reporting\_endpoint: bool 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: bool 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_update_response%20%3E%20(schema)>) #### Page ShieldPolicies ##### [List content security rules](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/policies/methods/list) page\_shield.policies.list(PolicyListParams\*\*kwargs) -> SyncSinglePage\[[PolicyListResponse]()] GET/zones/{zone\_id}/page\_shield/policies ##### [Get a content security rule](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/policies/methods/get) page\_shield.policies.get(strpolicy\_id, PolicyGetParams\*\*kwargs) -> [PolicyGetResponse]() GET/zones/{zone\_id}/page\_shield/policies/{policy\_id} ##### [Create a content security rule](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/policies/methods/create) page\_shield.policies.create(PolicyCreateParams\*\*kwargs) -> [PolicyCreateResponse]() POST/zones/{zone\_id}/page\_shield/policies ##### [Update a content security rule](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/policies/methods/update) page\_shield.policies.update(strpolicy\_id, PolicyUpdateParams\*\*kwargs) -> [PolicyUpdateResponse]() PUT/zones/{zone\_id}/page\_shield/policies/{policy\_id} ##### [Delete a content security rule](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/policies/methods/delete) page\_shield.policies.delete(strpolicy\_id, PolicyDeleteParams\*\*kwargs) DELETE/zones/{zone\_id}/page\_shield/policies/{policy\_id} ##### ModelsExpand Collapse
class PolicyListResponse: … id: str Identifier maxLength32 Link to this property
action: Literal\["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: str A description for the policy Link to this property enabled: bool Whether the policy is enabled Link to this property expression: str The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax Link to this property value: str 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)>)
class PolicyGetResponse: … id: str Identifier maxLength32 Link to this property
action: Literal\["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: str A description for the policy Link to this property enabled: bool Whether the policy is enabled Link to this property expression: str The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax Link to this property value: str The policy which will be applied Link to this property
[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_get_response%20%3E%20(schema)>)
class PolicyCreateResponse: … id: str Identifier maxLength32 Link to this property
action: Literal\["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: str A description for the policy Link to this property enabled: bool Whether the policy is enabled Link to this property expression: str The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax Link to this property value: str The policy which will be applied Link to this property
[Link to this property](<#(resource)%20page_shield.policies%20%3E%20(model)%20policy_create_response%20%3E%20(schema)>)
class PolicyUpdateResponse: … id: str Identifier maxLength32 Link to this property
action: Literal\["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: str A description for the policy Link to this property enabled: bool Whether the policy is enabled Link to this property expression: str The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax Link to this property value: str The policy which will be applied 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/python/resources/page_shield/subresources/connections/methods/list) page\_shield.connections.list(ConnectionListParams\*\*kwargs) -> SyncSinglePage\[[ConnectionListResponse]()] GET/zones/{zone\_id}/page\_shield/connections ##### [Get a detected connection](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/connections/methods/get) page\_shield.connections.get(strconnection\_id, ConnectionGetParams\*\*kwargs) -> [ConnectionGetResponse]() GET/zones/{zone\_id}/page\_shield/connections/{connection\_id} ##### ModelsExpand Collapse
class ConnectionListResponse: … id: str Identifier maxLength32 Link to this property added\_at: datetime formatdate-time Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property url: str Link to this property url\_contains\_cdn\_cgi\_path: bool Link to this property domain\_reported\_malicious: Optional\[bool] Link to this property first\_page\_url: Optional\[str] Link to this property malicious\_domain\_categories: Optional\[List\[str]] Link to this property malicious\_url\_categories: Optional\[List\[str]] Link to this property page\_urls: Optional\[List\[str]] Link to this property url\_reported\_malicious: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20page_shield.connections%20%3E%20(model)%20connection_list_response%20%3E%20(schema)>)
class ConnectionGetResponse: … id: str Identifier maxLength32 Link to this property added\_at: datetime formatdate-time Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property url: str Link to this property url\_contains\_cdn\_cgi\_path: bool Link to this property domain\_reported\_malicious: Optional\[bool] Link to this property first\_page\_url: Optional\[str] Link to this property malicious\_domain\_categories: Optional\[List\[str]] Link to this property malicious\_url\_categories: Optional\[List\[str]] Link to this property page\_urls: Optional\[List\[str]] Link to this property url\_reported\_malicious: Optional\[bool] Link to this property
[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/python/resources/page_shield/subresources/scripts/methods/list) page\_shield.scripts.list(ScriptListParams\*\*kwargs) -> SyncSinglePage\[[ScriptListResponse]()] GET/zones/{zone\_id}/page\_shield/scripts ##### [Get a detected script](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/scripts/methods/get) page\_shield.scripts.get(strscript\_id, ScriptGetParams\*\*kwargs) -> [ScriptGetResponse]() GET/zones/{zone\_id}/page\_shield/scripts/{script\_id} ##### ModelsExpand Collapse
class ScriptListResponse: … id: str Identifier maxLength32 Link to this property added\_at: datetime formatdate-time Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property url: str Link to this property url\_contains\_cdn\_cgi\_path: bool Link to this property cryptomining\_score: Optional\[int] The cryptomining score of the JavaScript content. maximum99 minimum1 Link to this property Deprecateddataflow\_score: Optional\[int] 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: Optional\[bool] Link to this property fetched\_at: Optional\[str] The timestamp of when the script was last fetched. Link to this property first\_page\_url: Optional\[str] Link to this property hash: Optional\[str] The computed hash of the analyzed script. maxLength64 minLength64 Link to this property js\_integrity\_score: Optional\[int] The integrity score of the JavaScript content. maximum99 minimum1 Link to this property magecart\_score: Optional\[int] The magecart score of the JavaScript content. maximum99 minimum1 Link to this property malicious\_domain\_categories: Optional\[List\[str]] Link to this property malicious\_url\_categories: Optional\[List\[str]] Link to this property malware\_score: Optional\[int] The malware score of the JavaScript content. maximum99 minimum1 Link to this property Deprecatedobfuscation\_score: Optional\[int] 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: Optional\[List\[str]] Link to this property url\_reported\_malicious: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20page_shield.scripts%20%3E%20(model)%20script_list_response%20%3E%20(schema)>)
class ScriptGetResponse: … id: str Identifier maxLength32 Link to this property added\_at: datetime formatdate-time Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property url: str Link to this property url\_contains\_cdn\_cgi\_path: bool Link to this property cryptomining\_score: Optional\[int] The cryptomining score of the JavaScript content. maximum99 minimum1 Link to this property Deprecateddataflow\_score: Optional\[int] 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: Optional\[bool] Link to this property fetched\_at: Optional\[str] The timestamp of when the script was last fetched. Link to this property first\_page\_url: Optional\[str] Link to this property hash: Optional\[str] The computed hash of the analyzed script. maxLength64 minLength64 Link to this property js\_integrity\_score: Optional\[int] The integrity score of the JavaScript content. maximum99 minimum1 Link to this property magecart\_score: Optional\[int] The magecart score of the JavaScript content. maximum99 minimum1 Link to this property malicious\_domain\_categories: Optional\[List\[str]] Link to this property malicious\_url\_categories: Optional\[List\[str]] Link to this property malware\_score: Optional\[int] The malware score of the JavaScript content. maximum99 minimum1 Link to this property Deprecatedobfuscation\_score: Optional\[int] 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: Optional\[List\[str]] Link to this property url\_reported\_malicious: Optional\[bool] Link to this property
versions: Optional\[List\[Version]] cryptomining\_score: Optional\[int] The cryptomining score of the JavaScript content. maximum99 minimum1 Link to this property Deprecateddataflow\_score: Optional\[int] 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: Optional\[str] The timestamp of when the script was last fetched. Link to this property hash: Optional\[str] The computed hash of the analyzed script. maxLength64 minLength64 Link to this property js\_integrity\_score: Optional\[int] The integrity score of the JavaScript content. maximum99 minimum1 Link to this property magecart\_score: Optional\[int] The magecart score of the JavaScript content. maximum99 minimum1 Link to this property malware\_score: Optional\[int] The malware score of the JavaScript content. maximum99 minimum1 Link to this property Deprecatedobfuscation\_score: Optional\[int] 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/python/resources/page_shield/subresources/cookies/methods/list) page\_shield.cookies.list(CookieListParams\*\*kwargs) -> SyncSinglePage\[[CookieListResponse]()] GET/zones/{zone\_id}/page\_shield/cookies ##### [Get a detected cookie](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/cookies/methods/get) page\_shield.cookies.get(strcookie\_id, CookieGetParams\*\*kwargs) -> [CookieGetResponse]() GET/zones/{zone\_id}/page\_shield/cookies/{cookie\_id} ##### ModelsExpand Collapse
class CookieListResponse: … id: str Identifier maxLength32 Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property name: str Link to this property
type: Literal\["first\_party", "unknown"] One of the following: "first\_party" Link to this property "unknown" Link to this property
Link to this property domain\_attribute: Optional\[str] Link to this property expires\_attribute: Optional\[datetime] formatdate-time Link to this property http\_only\_attribute: Optional\[bool] Link to this property max\_age\_attribute: Optional\[int] Link to this property page\_urls: Optional\[List\[str]] Link to this property path\_attribute: Optional\[str] Link to this property
same\_site\_attribute: Optional\[Literal\["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: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_list_response%20%3E%20(schema)>)
class CookieGetResponse: … id: str Identifier maxLength32 Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property name: str Link to this property
type: Literal\["first\_party", "unknown"] One of the following: "first\_party" Link to this property "unknown" Link to this property
Link to this property domain\_attribute: Optional\[str] Link to this property expires\_attribute: Optional\[datetime] formatdate-time Link to this property http\_only\_attribute: Optional\[bool] Link to this property max\_age\_attribute: Optional\[int] Link to this property page\_urls: Optional\[List\[str]] Link to this property path\_attribute: Optional\[str] Link to this property
same\_site\_attribute: Optional\[Literal\["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: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)>)