--- title: Zaraz --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Zaraz ##### [Update Zaraz workflow](https://developers.cloudflare.com/api/resources/zaraz/methods/update) PUT/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse

ButtonTextTranslation object {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](<#(resource)%20zaraz%20%3E%20(model)%20button_text_translation%20%3E%20(schema)>)

NeoEvent object {actionType, blockingTriggers, data, firingTriggers }

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](<#(resource)%20zaraz%20%3E%20(model)%20neo_event%20%3E%20(schema)>) #### ZarazConfig ##### [Get Zaraz configuration](https://developers.cloudflare.com/api/resources/zaraz/subresources/config/methods/get) GET/zones/{zone\_id}/settings/zaraz/config ##### [Update Zaraz configuration](https://developers.cloudflare.com/api/resources/zaraz/subresources/config/methods/update) PUT/zones/{zone\_id}/settings/zaraz/config ##### ModelsExpand Collapse

Configuration object {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.

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.

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

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.

Link to this property defaultPurpose: optional string Default consent purpose ID. 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

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

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

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

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

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

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

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

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

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

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

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

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 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 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 } 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(model)%20configuration%20%3E%20(schema)>) #### ZarazDefault ##### [Get default Zaraz configuration](https://developers.cloudflare.com/api/resources/zaraz/subresources/default/methods/get) GET/zones/{zone\_id}/settings/zaraz/default #### ZarazExport ##### [Export Zaraz configuration](https://developers.cloudflare.com/api/resources/zaraz/subresources/export/methods/get) GET/zones/{zone\_id}/settings/zaraz/export #### ZarazHistory ##### [List Zaraz historical configuration records](https://developers.cloudflare.com/api/resources/zaraz/subresources/history/methods/list) GET/zones/{zone\_id}/settings/zaraz/history ##### [Restore Zaraz historical configuration by ID](https://developers.cloudflare.com/api/resources/zaraz/subresources/history/methods/update) PUT/zones/{zone\_id}/settings/zaraz/history ##### ModelsExpand Collapse

HistoryListResponse object {id, createdAt, description, 2 more }

id: number ID of the configuration. Link to this property createdAt: string Date and time the configuration was created. formatdate-time Link to this property description: string Configuration description provided by the user who published this configuration. Link to this property updatedAt: string Date and time the configuration was last updated. formatdate-time Link to this property userId: string Alpha-numeric ID of the account user who published the configuration. Link to this property

[Link to this property](<#(resource)%20zaraz.history%20%3E%20(model)%20history_list_response%20%3E%20(schema)>) #### ZarazHistoryConfigs ##### [Get Zaraz historical configurations by ID(s)](https://developers.cloudflare.com/api/resources/zaraz/subresources/history/subresources/configs/methods/get) GET/zones/{zone\_id}/settings/zaraz/history/configs ##### ModelsExpand Collapse

ConfigGetResponse = map\[object {id, config, createdAt, 2 more } ] Object where keys are numeric configuration IDs.

id: number ID of the configuration. Link to this property config: Configuration { dataLayer, debugKey, settings, 7 more } Zaraz configuration. Link to this property createdAt: string Date and time the configuration was created. formatdate-time Link to this property updatedAt: string Date and time the configuration was last updated. formatdate-time Link to this property userId: string Alpha-numeric ID of the account user who published the configuration. Link to this property

[Link to this property](<#(resource)%20zaraz.history.configs%20%3E%20(model)%20config_get_response%20%3E%20(schema)>) #### ZarazPublish ##### [Publish Zaraz preview configuration](https://developers.cloudflare.com/api/resources/zaraz/subresources/publish/methods/create) POST/zones/{zone\_id}/settings/zaraz/publish ##### ModelsExpand Collapse PublishCreateResponse = string [Link to this property](<#(resource)%20zaraz.publish%20%3E%20(model)%20publish_create_response%20%3E%20(schema)>) #### ZarazWorkflow ##### [Get Zaraz workflow](https://developers.cloudflare.com/api/resources/zaraz/subresources/workflow/methods/get) GET/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse

Workflow = "realtime"or "preview" Zaraz workflow.

One of the following: "realtime" Link to this property "preview" Link to this property

[Link to this property](<#(resource)%20zaraz.workflow%20%3E%20(model)%20workflow%20%3E%20(schema)>)