---
title: Get Zaraz configuration
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Zaraz](https://developers.cloudflare.com/api/resources/zaraz)
[Config](https://developers.cloudflare.com/api/resources/zaraz/subresources/config)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get Zaraz configuration
GET/zones/{zone\_id}/settings/zaraz/config
Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.
##### 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)
`Zaraz Edit``Zaraz Read``Zaraz Admin`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20zaraz.config%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {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)%20zaraz.config%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {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)%20zaraz.config%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: Configuration { dataLayer, debugKey, settings, 7 more }
Zaraz configuration.
dataLayer: boolean
Data layer compatibility mode enabled.
Link to this property
debugKey: string
The key for Zaraz debug mode.
Link to this property
settings: object {autoInjectScript, contextEnricher, cookieDomain, 11 more }
General Zaraz settings.
autoInjectScript: boolean
Automatic injection of Zaraz scripts enabled.
Link to this property
contextEnricher: optional object {escapedWorkerName, workerTag }
Details of the worker that receives and edits Zaraz Context object.
escapedWorkerName: string
Link to this property
workerTag: string
Link to this property
Link to this property
cookieDomain: optional string
The domain Zaraz will use for writing and reading its cookies.
Link to this property
ecommerce: optional boolean
Ecommerce API enabled.
Link to this property
eventsApiPath: optional string
Custom endpoint for server-side track events.
Link to this property
hideExternalReferer: optional boolean
Hiding external referrer URL enabled.
Link to this property
hideIPAddress: optional boolean
Trimming IP address enabled.
Link to this property
hideQueryParams: optional boolean
Removing URL query params enabled.
Link to this property
hideUserAgent: optional boolean
Removing sensitive data from User Agent string enabled.
Link to this property
initPath: optional string
Custom endpoint for Zaraz init script.
Link to this property
injectIframes: optional boolean
Injection of Zaraz scripts into iframes enabled.
Link to this property
mcRootPath: optional string
Custom path for Managed Components server functionalities.
Link to this property
scriptPath: optional string
Custom endpoint for Zaraz main script.
Link to this property
trackPath: optional string
Custom endpoint for Zaraz tracking requests.
Link to this property
Link to this property
tools: map\[object {blockingTriggers, component, defaultFields, 10 more } or object {blockingTriggers, component, defaultFields, 11 more } ]
Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
One of the following:
ZarazManagedComponent object {blockingTriggers, component, defaultFields, 10 more }
blockingTriggers: array of string
List of blocking trigger IDs.
Link to this property
component: string
Tool’s internal name.
Link to this property
defaultFields: map\[stringor boolean]
Default fields for tool’s actions.
One of the following:
string
Link to this property
boolean
Link to this property
Link to this property
enabled: boolean
Whether tool is enabled.
Link to this property
name: string
Tool’s name defined by the user.
Link to this property
permissions: array of string
List of permissions granted to the component.
Link to this property
settings: map\[stringor boolean]
Tool’s settings.
One of the following:
string
Link to this property
boolean
Link to this property
Link to this property
type: "component"
Link to this property
actions: optional map\[NeoEvent { actionType, blockingTriggers, data, firingTriggers } ]
Actions configured on a tool. Either this or neoEvents field is required.
actionType: string
Tool event type.
Link to this property
blockingTriggers: array of string
List of blocking triggers IDs.
Link to this property
data: unknown
Event payload.
Link to this property
firingTriggers: array of string
List of firing triggers IDs.
Link to this property
Link to this property
defaultPurpose: optional string
Default consent purpose ID.
Link to this property
neoEvents: optional array of NeoEvent { actionType, blockingTriggers, data, firingTriggers }
DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.
actionType: string
Tool event type.
Link to this property
blockingTriggers: array of string
List of blocking triggers IDs.
Link to this property
data: unknown
Event payload.
Link to this property
firingTriggers: array of string
List of firing triggers IDs.
Link to this property
Link to this property
vendorName: optional string
Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.
Link to this property
vendorPolicyUrl: optional string
Vendor’s Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.
Link to this property
Link to this property
Worker object {blockingTriggers, component, defaultFields, 11 more }
blockingTriggers: array of string
List of blocking trigger IDs.
Link to this property
component: string
Tool’s internal name.
Link to this property
defaultFields: map\[stringor boolean]
Default fields for tool’s actions.
One of the following:
string
Link to this property
boolean
Link to this property
Link to this property
enabled: boolean
Whether tool is enabled.
Link to this property
name: string
Tool’s name defined by the user.
Link to this property
permissions: array of string
List of permissions granted to the component.
Link to this property
settings: map\[stringor boolean]
Tool’s settings.
One of the following:
string
Link to this property
boolean
Link to this property
Link to this property
type: "custom-mc"
Link to this property
worker: object {escapedWorkerName, workerTag }
Cloudflare worker that acts as a managed component.
escapedWorkerName: string
Link to this property
workerTag: string
Link to this property
Link to this property
actions: optional map\[NeoEvent { actionType, blockingTriggers, data, firingTriggers } ]
Actions configured on a tool. Either this or neoEvents field is required.
actionType: string
Tool event type.
Link to this property
blockingTriggers: array of string
List of blocking triggers IDs.
Link to this property
data: unknown
Event payload.
Link to this property
firingTriggers: array of string
List of firing triggers IDs.
Link to this property
Link to this property
defaultPurpose: optional string
Default consent purpose ID.
Link to this property
neoEvents: optional array of NeoEvent { actionType, blockingTriggers, data, firingTriggers }
DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.
actionType: string
Tool event type.
Link to this property
blockingTriggers: array of string
List of blocking triggers IDs.
Link to this property
data: unknown
Event payload.
Link to this property
firingTriggers: array of string
List of firing triggers IDs.
Link to this property
Link to this property
vendorName: optional string
Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.
Link to this property
vendorPolicyUrl: optional string
Vendor’s Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.
Link to this property
Link to this property
Link to this property
triggers: map\[object {excludeRules, loadRules, name, 2 more } ]
Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.
excludeRules: array of object {id, match, op, value } or object {id, action, settings } or object {id, action, settings } or 4 more
Rules defining when the trigger is not fired.
One of the following:
ZarazLoadRule object {id, match, op, value }
id: string
Link to this property
match: string
Link to this property
op: "CONTAINS"or "EQUALS"or "STARTS\_WITH"or 7 more
One of the following:
"CONTAINS"
Link to this property
"EQUALS"
Link to this property
"STARTS\_WITH"
Link to this property
"ENDS\_WITH"
Link to this property
"MATCH\_REGEX"
Link to this property
"NOT\_MATCH\_REGEX"
Link to this property
"GREATER\_THAN"
Link to this property
"GREATER\_THAN\_OR\_EQUAL"
Link to this property
"LESS\_THAN"
Link to this property
"LESS\_THAN\_OR\_EQUAL"
Link to this property
Link to this property
value: string
Link to this property
Link to this property
ZarazClickListenerRule object {id, action, settings }
id: string
Link to this property
action: "clickListener"
Link to this property
settings: object {selector, type, waitForTags }
selector: string
Link to this property
type: "xpath"or "css"
One of the following:
"xpath"
Link to this property
"css"
Link to this property
Link to this property
waitForTags: number
minimum0
Link to this property
Link to this property
Link to this property
ZarazTimerRule object {id, action, settings }
id: string
Link to this property
action: "timer"
Link to this property
settings: object {interval, limit }
interval: number
minimum50
Link to this property
limit: number
minimum0
Link to this property
Link to this property
Link to this property
ZarazFormSubmissionRule object {id, action, settings }
id: string
Link to this property
action: "formSubmission"
Link to this property
settings: object {selector, validate }
selector: string
Link to this property
validate: boolean
Link to this property
Link to this property
Link to this property
ZarazVariableMatchRule object {id, action, settings }
id: string
Link to this property
action: "variableMatch"
Link to this property
settings: object {match, variable }
match: string
Link to this property
variable: string
Link to this property
Link to this property
Link to this property
ZarazScrollDepthRule object {id, action, settings }
id: string
Link to this property
action: "scrollDepth"
Link to this property
settings: object {positions }
positions: string
Link to this property
Link to this property
Link to this property
ZarazElementVisibilityRule object {id, action, settings }
id: string
Link to this property
action: "elementVisibility"
Link to this property
settings: object {selector }
selector: string
Link to this property
Link to this property
Link to this property
Link to this property
loadRules: array of object {id, match, op, value } or object {id, action, settings } or object {id, action, settings } or 4 more
Rules defining when the trigger is fired.
One of the following:
ZarazLoadRule object {id, match, op, value }
id: string
Link to this property
match: string
Link to this property
op: "CONTAINS"or "EQUALS"or "STARTS\_WITH"or 7 more
One of the following:
"CONTAINS"
Link to this property
"EQUALS"
Link to this property
"STARTS\_WITH"
Link to this property
"ENDS\_WITH"
Link to this property
"MATCH\_REGEX"
Link to this property
"NOT\_MATCH\_REGEX"
Link to this property
"GREATER\_THAN"
Link to this property
"GREATER\_THAN\_OR\_EQUAL"
Link to this property
"LESS\_THAN"
Link to this property
"LESS\_THAN\_OR\_EQUAL"
Link to this property
Link to this property
value: string
Link to this property
Link to this property
ZarazClickListenerRule object {id, action, settings }
id: string
Link to this property
action: "clickListener"
Link to this property
settings: object {selector, type, waitForTags }
selector: string
Link to this property
type: "xpath"or "css"
One of the following:
"xpath"
Link to this property
"css"
Link to this property
Link to this property
waitForTags: number
minimum0
Link to this property
Link to this property
Link to this property
ZarazTimerRule object {id, action, settings }
id: string
Link to this property
action: "timer"
Link to this property
settings: object {interval, limit }
interval: number
minimum50
Link to this property
limit: number
minimum0
Link to this property
Link to this property
Link to this property
ZarazFormSubmissionRule object {id, action, settings }
id: string
Link to this property
action: "formSubmission"
Link to this property
settings: object {selector, validate }
selector: string
Link to this property
validate: boolean
Link to this property
Link to this property
Link to this property
ZarazVariableMatchRule object {id, action, settings }
id: string
Link to this property
action: "variableMatch"
Link to this property
settings: object {match, variable }
match: string
Link to this property
variable: string
Link to this property
Link to this property
Link to this property
ZarazScrollDepthRule object {id, action, settings }
id: string
Link to this property
action: "scrollDepth"
Link to this property
settings: object {positions }
positions: string
Link to this property
Link to this property
Link to this property
ZarazElementVisibilityRule object {id, action, settings }
id: string
Link to this property
action: "elementVisibility"
Link to this property
settings: object {selector }
selector: string
Link to this property
Link to this property
Link to this property
Link to this property
name: string
Trigger name.
Link to this property
description: optional string
Trigger description.
Link to this property
system: optional "pageload"
Link to this property
Link to this property
variables: map\[object {name, type, value } or object {name, type, value } or object {name, type, value } ]
Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.
One of the following:
String object {name, type, value }
name: string
Link to this property
type: "string"
Link to this property
value: string
Link to this property
Link to this property
Secret object {name, type, value }
name: string
Link to this property
type: "secret"
Link to this property
value: string
Link to this property
Link to this property
Worker object {name, type, value }
name: string
Link to this property
type: "worker"
Link to this property
value: object {escapedWorkerName, workerTag }
escapedWorkerName: string
Link to this property
workerTag: string
Link to this property
Link to this property
Link to this property
Link to this property
zarazVersion: number
Zaraz internal version of the config.
Link to this property
analytics: optional object {defaultPurpose, enabled, sessionExpTime }
Cloudflare Monitoring settings.
defaultPurpose: optional string
Consent purpose assigned to Monitoring.
Link to this property
enabled: optional boolean
Whether Advanced Monitoring reports are enabled.
Link to this property
sessionExpTime: optional number
Session expiration time (seconds).
maximum86400
minimum60
Link to this property
Link to this property
consent: optional object {enabled, buttonTextTranslations, companyEmail, 12 more }
Consent management configuration.
enabled: boolean
Link to this property
buttonTextTranslations: optional ButtonTextTranslation { accept\_all, confirm\_my\_choices, reject\_all }
accept\_all: map\[string]
Object where keys are language codes.
Link to this property
confirm\_my\_choices: map\[string]
Object where keys are language codes.
Link to this property
reject\_all: map\[string]
Object where keys are language codes.
Link to this property
Link to this property
companyEmail: optional string
Link to this property
companyName: optional string
Link to this property
companyStreetAddress: optional string
Link to this property
consentModalIntroHTML: optional string
Link to this property
consentModalIntroHTMLWithTranslations: optional map\[string]
Object where keys are language codes.
Link to this property
cookieName: optional string
Link to this property
customCSS: optional string
Link to this property
customIntroDisclaimerDismissed: optional boolean
Link to this property
defaultLanguage: optional string
Link to this property
hideModal: optional boolean
Link to this property
purposes: optional map\[object {description, name } ]
Object where keys are purpose alpha-numeric IDs.
description: string
Link to this property
name: string
Link to this property
Link to this property
purposesWithTranslations: optional map\[object {description, name, order } ]
Object where keys are purpose alpha-numeric IDs.
description: map\[string]
Object where keys are language codes.
Link to this property
name: map\[string]
Object where keys are language codes.
Link to this property
order: number
Link to this property
Link to this property
tcfCompliant: optional boolean
Link to this property
Link to this property
historyChange: optional boolean
Single Page Application support enabled.
Link to this property
[Link to this property](<#(resource)%20zaraz.config%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: boolean
Whether the API call was successful.
[Link to this property](<#(resource)%20zaraz.config%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Get Zaraz configuration
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/settings/zaraz/config \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"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": {
"dataLayer": true,
"debugKey": "debugKey",
"settings": {
"autoInjectScript": true,
"contextEnricher": {
"escapedWorkerName": "escapedWorkerName",
"workerTag": "workerTag"
},
"cookieDomain": "cookieDomain",
"ecommerce": true,
"eventsApiPath": "eventsApiPath",
"hideExternalReferer": true,
"hideIPAddress": true,
"hideQueryParams": true,
"hideUserAgent": true,
"initPath": "initPath",
"injectIframes": true,
"mcRootPath": "mcRootPath",
"scriptPath": "scriptPath",
"trackPath": "trackPath"
},
"tools": {
"foo": {
"blockingTriggers": [
"string"
],
"component": "component",
"defaultFields": {
"foo": "string"
},
"enabled": true,
"name": "name",
"permissions": [
"string"
],
"settings": {
"foo": "string"
},
"type": "component",
"actions": {
"foo": {
"actionType": "actionType",
"blockingTriggers": [
"string"
],
"data": {},
"firingTriggers": [
"string"
]
}
},
"defaultPurpose": "defaultPurpose",
"neoEvents": [
{
"actionType": "actionType",
"blockingTriggers": [
"string"
],
"data": {},
"firingTriggers": [
"string"
]
}
],
"vendorName": "vendorName",
"vendorPolicyUrl": "vendorPolicyUrl"
}
},
"triggers": {
"foo": {
"excludeRules": [
{
"id": "id",
"match": "match",
"op": "CONTAINS",
"value": "value"
}
],
"loadRules": [
{
"id": "id",
"match": "match",
"op": "CONTAINS",
"value": "value"
}
],
"name": "name",
"description": "description",
"system": "pageload"
}
},
"variables": {
"foo": {
"name": "name",
"type": "string",
"value": "value"
}
},
"zarazVersion": 0,
"analytics": {
"defaultPurpose": "defaultPurpose",
"enabled": true,
"sessionExpTime": 60
},
"consent": {
"enabled": true,
"buttonTextTranslations": {
"accept_all": {
"foo": "string"
},
"confirm_my_choices": {
"foo": "string"
},
"reject_all": {
"foo": "string"
}
},
"companyEmail": "companyEmail",
"companyName": "companyName",
"companyStreetAddress": "companyStreetAddress",
"consentModalIntroHTML": "consentModalIntroHTML",
"consentModalIntroHTMLWithTranslations": {
"foo": "string"
},
"cookieName": "cookieName",
"customCSS": "customCSS",
"customIntroDisclaimerDismissed": true,
"defaultLanguage": "defaultLanguage",
"hideModal": true,
"purposes": {
"foo": {
"description": "description",
"name": "name"
}
},
"purposesWithTranslations": {
"foo": {
"description": {
"foo": "string"
},
"name": {
"foo": "string"
},
"order": 0
}
},
"tcfCompliant": true
},
"historyChange": true
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"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": {
"dataLayer": true,
"debugKey": "debugKey",
"settings": {
"autoInjectScript": true,
"contextEnricher": {
"escapedWorkerName": "escapedWorkerName",
"workerTag": "workerTag"
},
"cookieDomain": "cookieDomain",
"ecommerce": true,
"eventsApiPath": "eventsApiPath",
"hideExternalReferer": true,
"hideIPAddress": true,
"hideQueryParams": true,
"hideUserAgent": true,
"initPath": "initPath",
"injectIframes": true,
"mcRootPath": "mcRootPath",
"scriptPath": "scriptPath",
"trackPath": "trackPath"
},
"tools": {
"foo": {
"blockingTriggers": [
"string"
],
"component": "component",
"defaultFields": {
"foo": "string"
},
"enabled": true,
"name": "name",
"permissions": [
"string"
],
"settings": {
"foo": "string"
},
"type": "component",
"actions": {
"foo": {
"actionType": "actionType",
"blockingTriggers": [
"string"
],
"data": {},
"firingTriggers": [
"string"
]
}
},
"defaultPurpose": "defaultPurpose",
"neoEvents": [
{
"actionType": "actionType",
"blockingTriggers": [
"string"
],
"data": {},
"firingTriggers": [
"string"
]
}
],
"vendorName": "vendorName",
"vendorPolicyUrl": "vendorPolicyUrl"
}
},
"triggers": {
"foo": {
"excludeRules": [
{
"id": "id",
"match": "match",
"op": "CONTAINS",
"value": "value"
}
],
"loadRules": [
{
"id": "id",
"match": "match",
"op": "CONTAINS",
"value": "value"
}
],
"name": "name",
"description": "description",
"system": "pageload"
}
},
"variables": {
"foo": {
"name": "name",
"type": "string",
"value": "value"
}
},
"zarazVersion": 0,
"analytics": {
"defaultPurpose": "defaultPurpose",
"enabled": true,
"sessionExpTime": 60
},
"consent": {
"enabled": true,
"buttonTextTranslations": {
"accept_all": {
"foo": "string"
},
"confirm_my_choices": {
"foo": "string"
},
"reject_all": {
"foo": "string"
}
},
"companyEmail": "companyEmail",
"companyName": "companyName",
"companyStreetAddress": "companyStreetAddress",
"consentModalIntroHTML": "consentModalIntroHTML",
"consentModalIntroHTMLWithTranslations": {
"foo": "string"
},
"cookieName": "cookieName",
"customCSS": "customCSS",
"customIntroDisclaimerDismissed": true,
"defaultLanguage": "defaultLanguage",
"hideModal": true,
"purposes": {
"foo": {
"description": "description",
"name": "name"
}
},
"purposesWithTranslations": {
"foo": {
"description": {
"foo": "string"
},
"name": {
"foo": "string"
},
"order": 0
}
},
"tcfCompliant": true
},
"historyChange": true
},
"success": true
}
```