Skip to content
Cloudflare API
Start here
API Reference

Logs

LogsLog Explorer

LogsLog ExplorerQuery

Run a log query
POST/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/query/sql
ModelsExpand Collapse
QuerySqlResponse = map[unknown]

LogsLog ExplorerDatasets

List account or zone datasets
GET/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets
Get an account or zone dataset
GET/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/{dataset_id}
Create an account or zone dataset
POST/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets
Update an account or zone dataset
PUT/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/{dataset_id}
Delete an account or zone dataset
DELETE/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/{dataset_id}
ModelsExpand Collapse
CreateRequest object { dataset, fields, filter }
dataset: string

Dataset type name to create (e.g. http_requests).

fields: optional array of object { enabled, name }

Controls which fields the API ingests. Defaults to all available fields when absent.

enabled: boolean

Whether the API includes this field in log ingest.

name: string

Field name in lowercase.

filter: optional string

Optional Logpush filter predicate to restrict which events are ingested. If provided, replaces the dataset’s default filter entirely. See Logpush filters for syntax and examples.

Dataset object { created_at, dataset, dataset_id, 7 more }

A Log Explorer dataset summary. List endpoints return this type and omit field configuration; use the single-dataset endpoint to retrieve it.

created_at: string

RFC3339 timestamp recording when the API created this dataset.

formatdate-time
dataset: string

Dataset type name (e.g. http_requests).

dataset_id: string

Unique dataset ID.

deletion_protection: boolean

Whether deletion is blocked. Set to false before deleting the dataset.

enabled: boolean

Whether log ingest is currently active for this dataset.

fields: array of object { enabled, name }

The field configuration for this dataset.

enabled: boolean

Whether the API includes this field in log ingest.

name: string

Field name in lowercase.

object_id: string

Public ID of the account or zone that owns this dataset.

object_type: "account" or "zone"

Whether this dataset belongs to an account or a zone.

One of the following:
"account"
"zone"
updated_at: string

RFC3339 timestamp recording when the API last updated this dataset.

formatdate-time
filter: optional string

The Logpush filter predicate applied to this dataset. Omitted when no filter is set.

DatasetSummary object { created_at, dataset, dataset_id, 5 more }

A Log Explorer dataset summary. List endpoints return this type and omit field configuration; use the single-dataset endpoint to retrieve it.

created_at: string

RFC3339 timestamp recording when the API created this dataset.

formatdate-time
dataset: string

Dataset type name (e.g. http_requests).

dataset_id: string

Unique dataset ID.

deletion_protection: boolean

Whether deletion is blocked. Set to false before deleting the dataset.

enabled: boolean

Whether log ingest is currently active for this dataset.

object_id: string

Public ID of the account or zone that owns this dataset.

object_type: "account" or "zone"

Whether this dataset belongs to an account or a zone.

One of the following:
"account"
"zone"
updated_at: string

RFC3339 timestamp recording when the API last updated this dataset.

formatdate-time
UpdateRequest object { enabled, deletion_protection, fields, filter }
enabled: boolean

Whether to enable or disable log ingest for this dataset.

deletion_protection: optional boolean

Set to false to allow deletion of this dataset.

fields: optional array of object { enabled, name }

Controls which fields the API ingests after the update. Defaults to all available fields when absent.

enabled: boolean

Whether the API includes this field in log ingest.

name: string

Field name in lowercase.

filter: optional string

Optional Logpush filter predicate to restrict which events are ingested. If omitted, the existing filter is left unchanged. Set to an empty string ("") to clear the filter. Otherwise, replaces the dataset’s filter entirely. See Logpush filters for syntax and examples.

LogsLog ExplorerDatasetsAvailable

List available account or zone datasets
GET/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/available
ModelsExpand Collapse
AvailableDataset object { dataset, object_type, schema, timestamp_field }

A dataset type that the account or zone can create.

dataset: string

Dataset type name (e.g. http_requests).

object_type: "account" or "zone"

Whether this dataset type is account-scoped or zone-scoped.

One of the following:
"account"
"zone"
schema: object { properties, required, type }

JSON Schema that describes the fields this dataset exposes.

properties: optional map[unknown]
required: optional array of string
type: optional "object"
timestamp_field: string

The primary timestamp field name for this dataset.

AvailableList object { errors, messages, success, result }
errors: array of ResponseInfo { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of string
success: boolean
result: optional array of AvailableDataset { dataset, object_type, schema, timestamp_field }
dataset: string

Dataset type name (e.g. http_requests).

object_type: "account" or "zone"

Whether this dataset type is account-scoped or zone-scoped.

One of the following:
"account"
"zone"
schema: object { properties, required, type }

JSON Schema that describes the fields this dataset exposes.

properties: optional map[unknown]
required: optional array of string
type: optional "object"
timestamp_field: string

The primary timestamp field name for this dataset.

LogsControl

LogsControlRetention

Get log retention flag
GET/zones/{zone_id}/logs/control/retention/flag
Update log retention flag
POST/zones/{zone_id}/logs/control/retention/flag
ModelsExpand Collapse
RetentionGetResponse object { flag }
flag: optional boolean

The log retention flag for Logpull API.

RetentionCreateResponse object { flag }
flag: optional boolean

The log retention flag for Logpull API.

LogsControlCmb

LogsControlCmbConfig

Get CMB config
GET/accounts/{account_id}/logs/control/cmb/config
Update CMB config
POST/accounts/{account_id}/logs/control/cmb/config
Delete CMB config
DELETE/accounts/{account_id}/logs/control/cmb/config
ModelsExpand Collapse
CmbConfig object { allow_out_of_region_access, regions }
allow_out_of_region_access: optional boolean

Allow out of region access

regions: optional string

Name of the region.

maxLength256
ConfigDeleteResponse = unknown

LogsRayID

Get logs RayIDs
GET/zones/{zone_id}/logs/rayids/{ray_id}
ModelsExpand Collapse
RayIDGetResponse = string or unknown
One of the following:
string
unknown

LogsReceived

Get logs received
GET/zones/{zone_id}/logs/received
ModelsExpand Collapse
ReceivedGetResponse = string or unknown
One of the following:
string
unknown

LogsReceivedFields

List fields
GET/zones/{zone_id}/logs/received/fields
ModelsExpand Collapse
FieldGetResponse object { key }
key: optional string