API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Logs

LogsControl

LogsControlRetention

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.

LogsControlCmb

LogsControlCmbConfig

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

LogsRayID

Get logs RayIDs

client.logs.RayID.get(stringRayID, RayIDGetParams { zone_id, fields, timestamps } params, RequestOptionsoptions?): RayIDGetResponse

GET/zones/{zone_id}/logs/rayids/{ray_id}

ModelsExpand Collapse

RayIDGetResponse = string | unknown

One of the following:

string

unknown

LogsReceived

Get logs received

client.logs.received.get(ReceivedGetParams { zone_id, end, count, 4 more } params, RequestOptionsoptions?): ReceivedGetResponse

GET/zones/{zone_id}/logs/received

ModelsExpand Collapse

ReceivedGetResponse = string | unknown

One of the following:

string

unknown

LogsReceivedFields

List fields

client.logs.received.fields.get(FieldGetParams { zone_id } params, RequestOptionsoptions?): FieldGetResponse { key }

GET/zones/{zone_id}/logs/received/fields

ModelsExpand Collapse

FieldGetResponse { key }

key?: string