--- title: Export Zaraz configuration --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zaraz](https://developers.cloudflare.com/api/python/resources/zaraz) [Export](https://developers.cloudflare.com/api/python/resources/zaraz/subresources/export) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Export Zaraz configuration zaraz.export.get(ExportGetParams\*\*kwargs) -> [Configuration]() GET/zones/{zone\_id}/settings/zaraz/export Exports full current published Zaraz configuration for a zone, secret variables 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` ##### ParametersExpand Collapse zone\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20zaraz.export%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Configuration: … Zaraz configuration. data\_layer: bool Data layer compatibility mode enabled. Link to this property debug\_key: str The key for Zaraz debug mode. Link to this property
settings: Settings General Zaraz settings. auto\_inject\_script: bool Automatic injection of Zaraz scripts enabled. Link to this property
context\_enricher: Optional\[SettingsContextEnricher] Details of the worker that receives and edits Zaraz Context object. escaped\_worker\_name: str Link to this property worker\_tag: str Link to this property
Link to this property cookie\_domain: Optional\[str] The domain Zaraz will use for writing and reading its cookies. Link to this property ecommerce: Optional\[bool] Ecommerce API enabled. Link to this property events\_api\_path: Optional\[str] Custom endpoint for server-side track events. Link to this property hide\_external\_referer: Optional\[bool] Hiding external referrer URL enabled. Link to this property hide\_ip\_address: Optional\[bool] Trimming IP address enabled. Link to this property hide\_query\_params: Optional\[bool] Removing URL query params enabled. Link to this property hide\_user\_agent: Optional\[bool] Removing sensitive data from User Agent string enabled. Link to this property init\_path: Optional\[str] Custom endpoint for Zaraz init script. Link to this property inject\_iframes: Optional\[bool] Injection of Zaraz scripts into iframes enabled. Link to this property mc\_root\_path: Optional\[str] Custom path for Managed Components server functionalities. Link to this property script\_path: Optional\[str] Custom endpoint for Zaraz main script. Link to this property track\_path: Optional\[str] Custom endpoint for Zaraz tracking requests. Link to this property
Link to this property
tools: Dict\[str, Tools] 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:
class ToolsZarazManagedComponent: … blocking\_triggers: List\[str] List of blocking trigger IDs. Link to this property component: str Tool’s internal name. Link to this property
default\_fields: Dict\[str, Union\[str, bool]] Default fields for tool’s actions. One of the following: str Link to this property bool Link to this property
Link to this property enabled: bool Whether tool is enabled. Link to this property name: str Tool’s name defined by the user. Link to this property permissions: List\[str] List of permissions granted to the component. Link to this property
settings: Dict\[str, Union\[str, bool]] Tool’s settings. One of the following: str Link to this property bool Link to this property
Link to this property type: Literal\["component"] Link to this property
actions: Optional\[Dict\[str, NeoEvent]] Actions configured on a tool. Either this or neoEvents field is required. action\_type: str Tool event type. Link to this property blocking\_triggers: List\[str] List of blocking triggers IDs. Link to this property data: object Event payload. Link to this property firing\_triggers: List\[str] List of firing triggers IDs. Link to this property
Link to this property default\_purpose: Optional\[str] Default consent purpose ID. Link to this property
neo\_events: Optional\[List\[NeoEvent]] DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence. action\_type: str Tool event type. Link to this property blocking\_triggers: List\[str] List of blocking triggers IDs. Link to this property data: object Event payload. Link to this property firing\_triggers: List\[str] List of firing triggers IDs. Link to this property
Link to this property vendor\_name: Optional\[str] Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned. Link to this property vendor\_policy\_url: Optional\[str] 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
class ToolsWorker: … blocking\_triggers: List\[str] List of blocking trigger IDs. Link to this property component: str Tool’s internal name. Link to this property
default\_fields: Dict\[str, Union\[str, bool]] Default fields for tool’s actions. One of the following: str Link to this property bool Link to this property
Link to this property enabled: bool Whether tool is enabled. Link to this property name: str Tool’s name defined by the user. Link to this property permissions: List\[str] List of permissions granted to the component. Link to this property
settings: Dict\[str, Union\[str, bool]] Tool’s settings. One of the following: str Link to this property bool Link to this property
Link to this property type: Literal\["custom-mc"] Link to this property
worker: ToolsWorkerWorker Cloudflare worker that acts as a managed component. escaped\_worker\_name: str Link to this property worker\_tag: str Link to this property
Link to this property
actions: Optional\[Dict\[str, NeoEvent]] Actions configured on a tool. Either this or neoEvents field is required. action\_type: str Tool event type. Link to this property blocking\_triggers: List\[str] List of blocking triggers IDs. Link to this property data: object Event payload. Link to this property firing\_triggers: List\[str] List of firing triggers IDs. Link to this property
Link to this property default\_purpose: Optional\[str] Default consent purpose ID. Link to this property
neo\_events: Optional\[List\[NeoEvent]] DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence. action\_type: str Tool event type. Link to this property blocking\_triggers: List\[str] List of blocking triggers IDs. Link to this property data: object Event payload. Link to this property firing\_triggers: List\[str] List of firing triggers IDs. Link to this property
Link to this property vendor\_name: Optional\[str] Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned. Link to this property vendor\_policy\_url: Optional\[str] 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: Dict\[str, Triggers] Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.
exclude\_rules: List\[TriggersExcludeRule] Rules defining when the trigger is not fired. One of the following:
class TriggersExcludeRuleZarazLoadRule: … id: str Link to this property match: str Link to this property
op: Literal\["CONTAINS", "EQUALS", "STARTS\_WITH", 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: str Link to this property
Link to this property
class TriggersExcludeRuleZarazClickListenerRule: … id: str Link to this property action: Literal\["clickListener"] Link to this property
settings: TriggersExcludeRuleZarazClickListenerRuleSettings selector: str Link to this property
type: Literal\["xpath", "css"] One of the following: "xpath" Link to this property "css" Link to this property
Link to this property wait\_for\_tags: int minimum0 Link to this property
Link to this property
Link to this property
class TriggersExcludeRuleZarazTimerRule: … id: str Link to this property action: Literal\["timer"] Link to this property
settings: TriggersExcludeRuleZarazTimerRuleSettings interval: int minimum50 Link to this property limit: int minimum0 Link to this property
Link to this property
Link to this property
class TriggersExcludeRuleZarazFormSubmissionRule: … id: str Link to this property action: Literal\["formSubmission"] Link to this property
settings: TriggersExcludeRuleZarazFormSubmissionRuleSettings selector: str Link to this property validate: bool Link to this property
Link to this property
Link to this property
class TriggersExcludeRuleZarazVariableMatchRule: … id: str Link to this property action: Literal\["variableMatch"] Link to this property
settings: TriggersExcludeRuleZarazVariableMatchRuleSettings match: str Link to this property variable: str Link to this property
Link to this property
Link to this property
class TriggersExcludeRuleZarazScrollDepthRule: … id: str Link to this property action: Literal\["scrollDepth"] Link to this property
settings: TriggersExcludeRuleZarazScrollDepthRuleSettings positions: str Link to this property
Link to this property
Link to this property
class TriggersExcludeRuleZarazElementVisibilityRule: … id: str Link to this property action: Literal\["elementVisibility"] Link to this property
settings: TriggersExcludeRuleZarazElementVisibilityRuleSettings selector: str Link to this property
Link to this property
Link to this property
Link to this property
load\_rules: List\[TriggersLoadRule] Rules defining when the trigger is fired. One of the following:
class TriggersLoadRuleZarazLoadRule: … id: str Link to this property match: str Link to this property
op: Literal\["CONTAINS", "EQUALS", "STARTS\_WITH", 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: str Link to this property
Link to this property
class TriggersLoadRuleZarazClickListenerRule: … id: str Link to this property action: Literal\["clickListener"] Link to this property
settings: TriggersLoadRuleZarazClickListenerRuleSettings selector: str Link to this property
type: Literal\["xpath", "css"] One of the following: "xpath" Link to this property "css" Link to this property
Link to this property wait\_for\_tags: int minimum0 Link to this property
Link to this property
Link to this property
class TriggersLoadRuleZarazTimerRule: … id: str Link to this property action: Literal\["timer"] Link to this property
settings: TriggersLoadRuleZarazTimerRuleSettings interval: int minimum50 Link to this property limit: int minimum0 Link to this property
Link to this property
Link to this property
class TriggersLoadRuleZarazFormSubmissionRule: … id: str Link to this property action: Literal\["formSubmission"] Link to this property
settings: TriggersLoadRuleZarazFormSubmissionRuleSettings selector: str Link to this property validate: bool Link to this property
Link to this property
Link to this property
class TriggersLoadRuleZarazVariableMatchRule: … id: str Link to this property action: Literal\["variableMatch"] Link to this property
settings: TriggersLoadRuleZarazVariableMatchRuleSettings match: str Link to this property variable: str Link to this property
Link to this property
Link to this property
class TriggersLoadRuleZarazScrollDepthRule: … id: str Link to this property action: Literal\["scrollDepth"] Link to this property
settings: TriggersLoadRuleZarazScrollDepthRuleSettings positions: str Link to this property
Link to this property
Link to this property
class TriggersLoadRuleZarazElementVisibilityRule: … id: str Link to this property action: Literal\["elementVisibility"] Link to this property
settings: TriggersLoadRuleZarazElementVisibilityRuleSettings selector: str Link to this property
Link to this property
Link to this property
Link to this property name: str Trigger name. Link to this property description: Optional\[str] Trigger description. Link to this property system: Optional\[Literal\["pageload"]] Link to this property
Link to this property
variables: Dict\[str, Variables] 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:
class VariablesZarazStringVariable: … name: str Link to this property type: Literal\["string"] Link to this property value: str Link to this property
Link to this property
class VariablesZarazSecretVariable: … name: str Link to this property type: Literal\["secret"] Link to this property value: str Link to this property
Link to this property
class VariablesZarazWorkerVariable: … name: str Link to this property type: Literal\["worker"] Link to this property
value: VariablesZarazWorkerVariableValue escaped\_worker\_name: str Link to this property worker\_tag: str Link to this property
Link to this property
Link to this property
Link to this property zaraz\_version: int Zaraz internal version of the config. Link to this property
analytics: Optional\[Analytics] Cloudflare Monitoring settings. default\_purpose: Optional\[str] Consent purpose assigned to Monitoring. Link to this property enabled: Optional\[bool] Whether Advanced Monitoring reports are enabled. Link to this property session\_exp\_time: Optional\[int] Session expiration time (seconds). maximum86400 minimum60 Link to this property
Link to this property
consent: Optional\[Consent] Consent management configuration. enabled: bool Link to this property
button\_text\_translations: Optional\[ButtonTextTranslation] accept\_all: Dict\[str, str] Object where keys are language codes. Link to this property confirm\_my\_choices: Dict\[str, str] Object where keys are language codes. Link to this property reject\_all: Dict\[str, str] Object where keys are language codes. Link to this property
Link to this property company\_email: Optional\[str] Link to this property company\_name: Optional\[str] Link to this property company\_street\_address: Optional\[str] Link to this property consent\_modal\_intro\_html: Optional\[str] Link to this property consent\_modal\_intro\_html\_with\_translations: Optional\[Dict\[str, str]] Object where keys are language codes. Link to this property cookie\_name: Optional\[str] Link to this property custom\_css: Optional\[str] Link to this property custom\_intro\_disclaimer\_dismissed: Optional\[bool] Link to this property default\_language: Optional\[str] Link to this property hide\_modal: Optional\[bool] Link to this property
purposes: Optional\[Dict\[str, ConsentPurposes]] Object where keys are purpose alpha-numeric IDs. description: str Link to this property name: str Link to this property
Link to this property
purposes\_with\_translations: Optional\[Dict\[str, ConsentPurposesWithTranslations]] Object where keys are purpose alpha-numeric IDs. description: Dict\[str, str] Object where keys are language codes. Link to this property name: Dict\[str, str] Object where keys are language codes. Link to this property order: int Link to this property
Link to this property tcf\_compliant: Optional\[bool] Link to this property
Link to this property history\_change: Optional\[bool] 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)>) ### Export Zaraz configuration Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) configuration = client.zaraz.export.get( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(configuration.data_layer) ``` 200 example ``` { "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 } ``` ##### Returns Examples 200 example ``` { "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 } ```