---
title: Get client-side security settings
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Page Shield](https://developers.cloudflare.com/api/resources/page_shield)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get client-side security settings
GET/zones/{zone\_id}/page\_shield
Returns the client-side security product enablement status and reporting behaviors.
##### 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)
`Page Shield``Domain Page Shield Read``Domain Page Shield``Page Shield Read``Zone Settings Write``Zone Settings Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier
maxLength32
[Link to this property](<#(resource)%20page_shield%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
success: true
Whether the API call was successful
[Link to this property](<#(resource)%20page_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
errors: optional array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20page_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: optional array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20page_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: optional object {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(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Get client-side security settings
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/page_shield \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"success": true,
"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": {
"enabled": true,
"updated_at": "2022-10-12T17:56:52.083582+01:00",
"use_cloudflare_reporting_endpoint": true,
"use_connection_url_path": true
}
}
```
##### Returns Examples
200 example
```
{
"success": true,
"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": {
"enabled": true,
"updated_at": "2022-10-12T17:56:52.083582+01:00",
"use_cloudflare_reporting_endpoint": true,
"use_connection_url_path": true
}
}
```