## Restore Zaraz historical configuration by ID

`client.zaraz.history.update(HistoryUpdateParamsparams, RequestOptionsoptions?): Configuration`

**put** `/zones/{zone_id}/settings/zaraz/history`

Restores a historical published Zaraz configuration by ID for a zone.

### Parameters

- `params: HistoryUpdateParams`

  - `zone_id: string`

    Path param: Identifier.

  - `body: number`

    Body param: ID of the Zaraz configuration to restore.

### Returns

- `Configuration`

  Zaraz configuration.

  - `dataLayer: boolean`

    Data layer compatibility mode enabled.

  - `debugKey: string`

    The key for Zaraz debug mode.

  - `settings: Settings`

    General Zaraz settings.

    - `autoInjectScript: boolean`

      Automatic injection of Zaraz scripts enabled.

    - `contextEnricher?: ContextEnricher`

      Details of the worker that receives and edits Zaraz Context object.

      - `escapedWorkerName: string`

      - `workerTag: string`

    - `cookieDomain?: string`

      The domain Zaraz will use for writing and reading its cookies.

    - `ecommerce?: boolean`

      Ecommerce API enabled.

    - `eventsApiPath?: string`

      Custom endpoint for server-side track events.

    - `hideExternalReferer?: boolean`

      Hiding external referrer URL enabled.

    - `hideIPAddress?: boolean`

      Trimming IP address enabled.

    - `hideQueryParams?: boolean`

      Removing URL query params enabled.

    - `hideUserAgent?: boolean`

      Removing sensitive data from User Agent string enabled.

    - `initPath?: string`

      Custom endpoint for Zaraz init script.

    - `injectIframes?: boolean`

      Injection of Zaraz scripts into iframes enabled.

    - `mcRootPath?: string`

      Custom path for Managed Components server functionalities.

    - `scriptPath?: string`

      Custom endpoint for Zaraz main script.

    - `trackPath?: string`

      Custom endpoint for Zaraz tracking requests.

  - `tools: Record<string, ZarazManagedComponent | Worker>`

    Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.

    - `ZarazManagedComponent`

      - `blockingTriggers: Array<string>`

        List of blocking trigger IDs.

      - `component: string`

        Tool's internal name.

      - `defaultFields: Record<string, string | boolean>`

        Default fields for tool's actions.

        - `string`

        - `boolean`

      - `enabled: boolean`

        Whether tool is enabled.

      - `name: string`

        Tool's name defined by the user.

      - `permissions: Array<string>`

        List of permissions granted to the component.

      - `settings: Record<string, string | boolean>`

        Tool's settings.

        - `string`

        - `boolean`

      - `type: "component"`

        - `"component"`

      - `actions?: Record<string, NeoEvent>`

        Actions configured on a tool. Either this or neoEvents field is required.

        - `actionType: string`

          Tool event type.

        - `blockingTriggers: Array<string>`

          List of blocking triggers IDs.

        - `data: unknown`

          Event payload.

        - `firingTriggers: Array<string>`

          List of firing triggers IDs.

      - `defaultPurpose?: string`

        Default consent purpose ID.

      - `neoEvents?: Array<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.

        - `actionType: string`

          Tool event type.

        - `blockingTriggers: Array<string>`

          List of blocking triggers IDs.

        - `data: unknown`

          Event payload.

        - `firingTriggers: Array<string>`

          List of firing triggers IDs.

      - `vendorName?: string`

        Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

      - `vendorPolicyUrl?: string`

        Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

    - `Worker`

      - `blockingTriggers: Array<string>`

        List of blocking trigger IDs.

      - `component: string`

        Tool's internal name.

      - `defaultFields: Record<string, string | boolean>`

        Default fields for tool's actions.

        - `string`

        - `boolean`

      - `enabled: boolean`

        Whether tool is enabled.

      - `name: string`

        Tool's name defined by the user.

      - `permissions: Array<string>`

        List of permissions granted to the component.

      - `settings: Record<string, string | boolean>`

        Tool's settings.

        - `string`

        - `boolean`

      - `type: "custom-mc"`

        - `"custom-mc"`

      - `worker: Worker`

        Cloudflare worker that acts as a managed component.

        - `escapedWorkerName: string`

        - `workerTag: string`

      - `actions?: Record<string, NeoEvent>`

        Actions configured on a tool. Either this or neoEvents field is required.

        - `actionType: string`

          Tool event type.

        - `blockingTriggers: Array<string>`

          List of blocking triggers IDs.

        - `data: unknown`

          Event payload.

        - `firingTriggers: Array<string>`

          List of firing triggers IDs.

      - `defaultPurpose?: string`

        Default consent purpose ID.

      - `neoEvents?: Array<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.

        - `actionType: string`

          Tool event type.

        - `blockingTriggers: Array<string>`

          List of blocking triggers IDs.

        - `data: unknown`

          Event payload.

        - `firingTriggers: Array<string>`

          List of firing triggers IDs.

      - `vendorName?: string`

        Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

      - `vendorPolicyUrl?: string`

        Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

  - `triggers: Record<string, Triggers>`

    Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.

    - `excludeRules: Array<ZarazLoadRule | ZarazClickListenerRule | ZarazTimerRule | 4 more>`

      Rules defining when the trigger is not fired.

      - `ZarazLoadRule`

        - `id: string`

        - `match: string`

        - `op: "CONTAINS" | "EQUALS" | "STARTS_WITH" | 7 more`

          - `"CONTAINS"`

          - `"EQUALS"`

          - `"STARTS_WITH"`

          - `"ENDS_WITH"`

          - `"MATCH_REGEX"`

          - `"NOT_MATCH_REGEX"`

          - `"GREATER_THAN"`

          - `"GREATER_THAN_OR_EQUAL"`

          - `"LESS_THAN"`

          - `"LESS_THAN_OR_EQUAL"`

        - `value: string`

      - `ZarazClickListenerRule`

        - `id: string`

        - `action: "clickListener"`

          - `"clickListener"`

        - `settings: Settings`

          - `selector: string`

          - `type: "xpath" | "css"`

            - `"xpath"`

            - `"css"`

          - `waitForTags: number`

      - `ZarazTimerRule`

        - `id: string`

        - `action: "timer"`

          - `"timer"`

        - `settings: Settings`

          - `interval: number`

          - `limit: number`

      - `ZarazFormSubmissionRule`

        - `id: string`

        - `action: "formSubmission"`

          - `"formSubmission"`

        - `settings: Settings`

          - `selector: string`

          - `validate: boolean`

      - `ZarazVariableMatchRule`

        - `id: string`

        - `action: "variableMatch"`

          - `"variableMatch"`

        - `settings: Settings`

          - `match: string`

          - `variable: string`

      - `ZarazScrollDepthRule`

        - `id: string`

        - `action: "scrollDepth"`

          - `"scrollDepth"`

        - `settings: Settings`

          - `positions: string`

      - `ZarazElementVisibilityRule`

        - `id: string`

        - `action: "elementVisibility"`

          - `"elementVisibility"`

        - `settings: Settings`

          - `selector: string`

    - `loadRules: Array<ZarazLoadRule | ZarazClickListenerRule | ZarazTimerRule | 4 more>`

      Rules defining when the trigger is fired.

      - `ZarazLoadRule`

        - `id: string`

        - `match: string`

        - `op: "CONTAINS" | "EQUALS" | "STARTS_WITH" | 7 more`

          - `"CONTAINS"`

          - `"EQUALS"`

          - `"STARTS_WITH"`

          - `"ENDS_WITH"`

          - `"MATCH_REGEX"`

          - `"NOT_MATCH_REGEX"`

          - `"GREATER_THAN"`

          - `"GREATER_THAN_OR_EQUAL"`

          - `"LESS_THAN"`

          - `"LESS_THAN_OR_EQUAL"`

        - `value: string`

      - `ZarazClickListenerRule`

        - `id: string`

        - `action: "clickListener"`

          - `"clickListener"`

        - `settings: Settings`

          - `selector: string`

          - `type: "xpath" | "css"`

            - `"xpath"`

            - `"css"`

          - `waitForTags: number`

      - `ZarazTimerRule`

        - `id: string`

        - `action: "timer"`

          - `"timer"`

        - `settings: Settings`

          - `interval: number`

          - `limit: number`

      - `ZarazFormSubmissionRule`

        - `id: string`

        - `action: "formSubmission"`

          - `"formSubmission"`

        - `settings: Settings`

          - `selector: string`

          - `validate: boolean`

      - `ZarazVariableMatchRule`

        - `id: string`

        - `action: "variableMatch"`

          - `"variableMatch"`

        - `settings: Settings`

          - `match: string`

          - `variable: string`

      - `ZarazScrollDepthRule`

        - `id: string`

        - `action: "scrollDepth"`

          - `"scrollDepth"`

        - `settings: Settings`

          - `positions: string`

      - `ZarazElementVisibilityRule`

        - `id: string`

        - `action: "elementVisibility"`

          - `"elementVisibility"`

        - `settings: Settings`

          - `selector: string`

    - `name: string`

      Trigger name.

    - `description?: string`

      Trigger description.

    - `system?: "pageload"`

      - `"pageload"`

  - `variables: Record<string, ZarazStringVariable | ZarazSecretVariable | ZarazWorkerVariable>`

    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.

    - `ZarazStringVariable`

      - `name: string`

      - `type: "string"`

        - `"string"`

      - `value: string`

    - `ZarazSecretVariable`

      - `name: string`

      - `type: "secret"`

        - `"secret"`

      - `value: string`

    - `ZarazWorkerVariable`

      - `name: string`

      - `type: "worker"`

        - `"worker"`

      - `value: Value`

        - `escapedWorkerName: string`

        - `workerTag: string`

  - `zarazVersion: number`

    Zaraz internal version of the config.

  - `analytics?: Analytics`

    Cloudflare Monitoring settings.

    - `defaultPurpose?: string`

      Consent purpose assigned to Monitoring.

    - `enabled?: boolean`

      Whether Advanced Monitoring reports are enabled.

    - `sessionExpTime?: number`

      Session expiration time (seconds).

  - `consent?: Consent`

    Consent management configuration.

    - `enabled: boolean`

    - `buttonTextTranslations?: ButtonTextTranslation`

      - `accept_all: Record<string, string>`

        Object where keys are language codes.

      - `confirm_my_choices: Record<string, string>`

        Object where keys are language codes.

      - `reject_all: Record<string, string>`

        Object where keys are language codes.

    - `companyEmail?: string`

    - `companyName?: string`

    - `companyStreetAddress?: string`

    - `consentModalIntroHTML?: string`

    - `consentModalIntroHTMLWithTranslations?: Record<string, string>`

      Object where keys are language codes.

    - `cookieName?: string`

    - `customCSS?: string`

    - `customIntroDisclaimerDismissed?: boolean`

    - `defaultLanguage?: string`

    - `hideModal?: boolean`

    - `purposes?: Record<string, Purposes>`

      Object where keys are purpose alpha-numeric IDs.

      - `description: string`

      - `name: string`

    - `purposesWithTranslations?: Record<string, PurposesWithTranslations>`

      Object where keys are purpose alpha-numeric IDs.

      - `description: Record<string, string>`

        Object where keys are language codes.

      - `name: Record<string, string>`

        Object where keys are language codes.

      - `order: number`

    - `tcfCompliant?: boolean`

  - `historyChange?: boolean`

    Single Page Application support enabled.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const configuration = await client.zaraz.history.update({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  body: 12345,
});

console.log(configuration.dataLayer);
```

#### Response

```json
{
  "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
}
```