API Reference

Zaraz

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

History

List Zaraz historical configuration records

zaraz.history.list(HistoryListParams**kwargs) -> SyncSinglePage[HistoryListResponse]

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

Restore Zaraz historical configuration by ID

zaraz.history.update(HistoryUpdateParams**kwargs) -> Configuration

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

ModelsExpand Collapse

class HistoryListResponse: …

id: int

ID of the configuration.

created_at: datetime

Date and time the configuration was created.

formatdate-time

description: str

Configuration description provided by the user who published this configuration.

updated_at: datetime

Date and time the configuration was last updated.

formatdate-time

user_id: str

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

HistoryConfigs

Get Zaraz historical configurations by ID(s)

zaraz.history.configs.get(ConfigGetParams**kwargs) -> ConfigGetResponse

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

ModelsExpand Collapse

Dict[str, ConfigGetResponseItem]

Object where keys are numeric configuration IDs.

id: int

ID of the configuration.

config: Configuration

Zaraz configuration.

created_at: datetime

Date and time the configuration was created.

formatdate-time

updated_at: datetime

Date and time the configuration was last updated.

formatdate-time

user_id: str

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