API Reference

Logs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Control

ControlRetention

Get log retention flag

client.logs.control.retention.get(RetentionGetParams { zone_id } params, RequestOptionsoptions?): RetentionGetResponse { flag } | null

GET/zones/{zone_id}/logs/control/retention/flag

Update log retention flag

client.logs.control.retention.create(RetentionCreateParams { zone_id, flag } params, RequestOptionsoptions?): RetentionCreateResponse { flag } | null

POST/zones/{zone_id}/logs/control/retention/flag

ModelsExpand Collapse

RetentionGetResponse { flag }

flag?: boolean

The log retention flag for Logpull API.

RetentionCreateResponse { flag }

flag?: boolean

The log retention flag for Logpull API.

ControlCmb

ControlCmbConfig

Get CMB config

client.logs.control.cmb.config.get(ConfigGetParams { account_id } params, RequestOptionsoptions?): CmbConfig { allow_out_of_region_access, regions } | null

GET/accounts/{account_id}/logs/control/cmb/config

Update CMB config

client.logs.control.cmb.config.create(ConfigCreateParams { account_id, allow_out_of_region_access, regions } params, RequestOptionsoptions?): CmbConfig { allow_out_of_region_access, regions } | null

POST/accounts/{account_id}/logs/control/cmb/config

Delete CMB config

client.logs.control.cmb.config.delete(ConfigDeleteParams { account_id } params, RequestOptionsoptions?): ConfigDeleteResponse | null

DELETE/accounts/{account_id}/logs/control/cmb/config

ModelsExpand Collapse

CmbConfig { allow_out_of_region_access, regions }

allow_out_of_region_access?: boolean

Allow out of region access

regions?: string

Name of the region.

maxLength256

ConfigDeleteResponse = unknown