List Zaraz historical configuration records

client.zaraz.history.list(, ?): SinglePage<HistoryListResponse { id, createdAt, description, 2 more } >

GET/zones/{zone_id}/settings/zaraz/history

Lists a history of published Zaraz configuration records for a zone.

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 EditZaraz ReadZaraz Admin

ParametersExpand Collapse

params: HistoryListParams { zone_id, limit, offset, 2 more }

zone_id: string

Path param: Identifier.

maxLength32

limit?: number

Query param: Maximum amount of results to list. Default value is 10.

minimum1

offset?: number

Query param: Ordinal number to start listing the results with. Default value is 0.

minimum0

sortField?: "id" | "user_id" | "description" | 2 more

Query param: The field to sort by. Default is updated_at.

One of the following:

"id"

"user_id"

"description"

"created_at"

"updated_at"

sortOrder?: "DESC" | "ASC"

Query param: Sorting order. Default is DESC.

One of the following:

"DESC"

"ASC"

ReturnsExpand Collapse

HistoryListResponse { id, createdAt, description, 2 more }

id: number

ID of the configuration.

createdAt: string

Date and time the configuration was created.

formatdate-time

description: string

Configuration description provided by the user who published this configuration.

updatedAt: string

Date and time the configuration was last updated.

formatdate-time

userId: string

Alpha-numeric ID of the account user who published the configuration.

List Zaraz historical configuration records

import Cloudflare from 'cloudflare';

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

// Automatically fetches more pages as needed.
for await (const historyListResponse of client.zaraz.history.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(historyListResponse.id);
}

{
  "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": [
    {
      "id": 0,
      "createdAt": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "updatedAt": "2019-12-27T18:11:19.117Z",
      "userId": "userId"
    }
  ],
  "success": true
}

Returns Examples

{
  "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": [
    {
      "id": 0,
      "createdAt": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "updatedAt": "2019-12-27T18:11:19.117Z",
      "userId": "userId"
    }
  ],
  "success": true
}