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

logs.control.retention.get(RetentionGetParams**kwargs) -> RetentionGetResponse

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

Update log retention flag

logs.control.retention.create(RetentionCreateParams**kwargs) -> RetentionCreateResponse

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

ModelsExpand Collapse

class RetentionGetResponse: …

flag: Optional[bool]

The log retention flag for Logpull API.

class RetentionCreateResponse: …

flag: Optional[bool]

The log retention flag for Logpull API.

LogsControlCmb

LogsControlCmbConfig

Get CMB config

logs.control.cmb.config.get(ConfigGetParams**kwargs) -> CmbConfig

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

Update CMB config

logs.control.cmb.config.create(ConfigCreateParams**kwargs) -> CmbConfig

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

Delete CMB config

logs.control.cmb.config.delete(ConfigDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class CmbConfig: …

allow_out_of_region_access: Optional[bool]

Allow out of region access

regions: Optional[str]

Name of the region.

maxLength256

LogsRayID

Get logs RayIDs

logs.rayid.get(strrayid, RayIDGetParams**kwargs) -> RayIDGetResponse

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

ModelsExpand Collapse

Union[str, object]

One of the following:

str

object

LogsReceived

Get logs received

logs.received.get(ReceivedGetParams**kwargs) -> ReceivedGetResponse

GET/zones/{zone_id}/logs/received

ModelsExpand Collapse

Union[str, object]

One of the following:

str

object

LogsReceivedFields

List fields

logs.received.fields.get(FieldGetParams**kwargs) -> FieldGetResponse

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

ModelsExpand Collapse

class FieldGetResponse: …

key: Optional[str]