--- title: Logs --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Logs #### LogsLog Explorer #### LogsLog ExplorerQuery ##### [Run a log query](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/query/methods/sql) client.logs.logExplorer.query.sql(QuerySqlParams {body, account\_id, zone\_id } params, RequestOptionsoptions?): SinglePage< [QuerySqlResponse]()> POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/query/sql ##### ModelsExpand Collapse QuerySqlResponse = Record [Link to this property](<#(resource)%20logs.log_explorer.query%20%3E%20(model)%20query_sql_response%20%3E%20(schema)>) #### LogsLog ExplorerDatasets ##### [List account or zone datasets](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/methods/list) client.logs.logExplorer.datasets.list(DatasetListParams {account\_id, zone\_id, include\_zones } params?, RequestOptionsoptions?): SinglePage< [DatasetSummary]() {created\_at, dataset, dataset\_id, 5 more } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets ##### [Get an account or zone dataset](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/methods/get) client.logs.logExplorer.datasets.get(stringdatasetID, DatasetGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [Dataset]() {created\_at, dataset, dataset\_id, 8 more } GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets/{dataset\_id} ##### [Create an account or zone dataset](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/methods/create) client.logs.logExplorer.datasets.create(DatasetCreateParams {dataset, account\_id, zone\_id, 3 more } params, RequestOptionsoptions?): [Dataset]() {created\_at, dataset, dataset\_id, 8 more } POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets ##### [Update an account or zone dataset](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/methods/update) client.logs.logExplorer.datasets.update(stringdatasetID, DatasetUpdateParams {enabled, account\_id, zone\_id, 4 more } params, RequestOptionsoptions?): [Dataset]() {created\_at, dataset, dataset\_id, 8 more } PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets/{dataset\_id} ##### [Delete an account or zone dataset](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/methods/delete) client.logs.logExplorer.datasets.delete(stringdatasetID, DatasetDeleteParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [Dataset]() {created\_at, dataset, dataset\_id, 8 more } DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets/{dataset\_id} ##### ModelsExpand Collapse
CreateRequest {dataset, fields, filter, filter\_attack\_traffic } dataset: string Dataset type name to create (e.g. http_requests). Link to this property
fields?: Array<Field> Controls which fields the API ingests. Defaults to all available fields when absent. enabled: boolean Whether the API includes this field in log ingest. Link to this property name: string Field name in lowercase. Link to this property
Link to this property filter?: string Optional Logpush filter predicate to restrict which events are ingested. See Logpush filters for syntax and examples. Link to this property filter\_attack\_traffic?: boolean Whether to filter attack traffic from the Logpush job. Defaults to true for supported datasets when omitted. Supported datasets are http_requests, firewall_events, and network_analytics_logs. Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets%20%3E%20(model)%20create_request%20%3E%20(schema)>)
Dataset {created\_at, dataset, dataset\_id, 8 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 Link to this property dataset: string Dataset type name (e.g. http_requests). Link to this property dataset\_id: string Unique dataset ID. Link to this property deletion\_protection: boolean Whether deletion is blocked. Set to false before deleting the dataset. Link to this property enabled: boolean Whether log ingest is currently active for this dataset. Link to this property
fields: Array<Field> The field configuration for this dataset. enabled: boolean Whether the API includes this field in log ingest. Link to this property name: string Field name in lowercase. Link to this property
Link to this property object\_id: string Public ID of the account or zone that owns this dataset. Link to this property
object\_type: "account"| "zone" Whether this dataset belongs to an account or a zone. One of the following: "account" Link to this property "zone" Link to this property
Link to this property updated\_at: string RFC3339 timestamp recording when the API last updated this dataset. formatdate-time Link to this property filter?: string The Logpush filter predicate applied to this dataset. Omitted when no filter is set. Link to this property filter\_attack\_traffic?: boolean Whether the Logpush job filters attack traffic. Omitted for datasets that do not support this option. Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets%20%3E%20(model)%20dataset%20%3E%20(schema)>)
DatasetSummary {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 Link to this property dataset: string Dataset type name (e.g. http_requests). Link to this property dataset\_id: string Unique dataset ID. Link to this property deletion\_protection: boolean Whether deletion is blocked. Set to false before deleting the dataset. Link to this property enabled: boolean Whether log ingest is currently active for this dataset. Link to this property object\_id: string Public ID of the account or zone that owns this dataset. Link to this property
object\_type: "account"| "zone" Whether this dataset belongs to an account or a zone. One of the following: "account" Link to this property "zone" Link to this property
Link to this property updated\_at: string RFC3339 timestamp recording when the API last updated this dataset. formatdate-time Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets%20%3E%20(model)%20dataset_summary%20%3E%20(schema)>)
UpdateRequest {enabled, deletion\_protection, fields, 2 more } enabled: boolean Whether to enable or disable log ingest for this dataset. Link to this property deletion\_protection?: boolean Set to false to allow deletion of this dataset. Link to this property
fields?: Array<Field> 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. Link to this property name: string Field name in lowercase. Link to this property
Link to this property filter?: string| null 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. Link to this property filter\_attack\_traffic?: boolean Whether to filter attack traffic from the Logpush job. If omitted, the existing setting is left unchanged. Supported datasets are http_requests, firewall_events, and network_analytics_logs. Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets%20%3E%20(model)%20update_request%20%3E%20(schema)>) #### LogsLog ExplorerDatasetsAvailable ##### [List available account or zone datasets](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/log_explorer/subresources/datasets/subresources/available/methods/list) client.logs.logExplorer.datasets.available.list(AvailableListParams {account\_id, zone\_id } params?, RequestOptionsoptions?): SinglePage< [AvailableDataset]() {dataset, object\_type, schema, timestamp\_field } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logs/explorer/datasets/available ##### ModelsExpand Collapse
AvailableDataset {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). Link to this property
object\_type: "account"| "zone" Whether this dataset type is account-scoped or zone-scoped. One of the following: "account" Link to this property "zone" Link to this property
Link to this property
schema: Schema {properties, required, type } JSON Schema that describes the fields this dataset exposes. properties?: Record<string, unknown> Link to this property required?: Array<string> Link to this property type?: "object" Link to this property
Link to this property timestamp\_field: string The primary timestamp field name for this dataset. Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets.available%20%3E%20(model)%20available_dataset%20%3E%20(schema)>)
AvailableList {errors, messages, success, result }
errors: Array<ResponseInfo {code, message, documentation\_url, source } > code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property messages: Array<string> Link to this property success: boolean Link to this property
result?: Array<AvailableDataset {dataset, object\_type, schema, timestamp\_field } >| null dataset: string Dataset type name (e.g. http_requests). Link to this property
object\_type: "account"| "zone" Whether this dataset type is account-scoped or zone-scoped. One of the following: "account" Link to this property "zone" Link to this property
Link to this property
schema: Schema {properties, required, type } JSON Schema that describes the fields this dataset exposes. properties?: Record<string, unknown> Link to this property required?: Array<string> Link to this property type?: "object" Link to this property
Link to this property timestamp\_field: string The primary timestamp field name for this dataset. Link to this property
Link to this property
[Link to this property](<#(resource)%20logs.log_explorer.datasets.available%20%3E%20(model)%20available_list%20%3E%20(schema)>) #### LogsControl #### LogsControlRetention ##### [Get log retention flag](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/control/subresources/retention/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/control/subresources/retention/methods/create) 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. Link to this property
[Link to this property](<#(resource)%20logs.control.retention%20%3E%20(model)%20retention_get_response%20%3E%20(schema)>)
RetentionCreateResponse {flag } flag?: boolean The log retention flag for Logpull API. Link to this property
[Link to this property](<#(resource)%20logs.control.retention%20%3E%20(model)%20retention_create_response%20%3E%20(schema)>) #### LogsControlCmb #### LogsControlCmbConfig ##### [Get CMB config](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/control/subresources/cmb/subresources/config/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/control/subresources/cmb/subresources/config/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/control/subresources/cmb/subresources/config/methods/delete) 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 Link to this property regions?: string Name of the region. maxLength256 Link to this property
[Link to this property](<#(resource)%20logs.control.cmb.config%20%3E%20(model)%20cmb_config%20%3E%20(schema)>) ConfigDeleteResponse = unknown [Link to this property](<#(resource)%20logs.control.cmb.config%20%3E%20(model)%20config_delete_response%20%3E%20(schema)>) #### LogsRayID ##### [Get logs RayIDs](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/rayid/methods/get) 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 Link to this property unknown Link to this property
[Link to this property](<#(resource)%20logs.rayid%20%3E%20(model)%20rayid_get_response%20%3E%20(schema)>) #### LogsReceived ##### [Get logs received](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/received/methods/get) 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 Link to this property unknown Link to this property
[Link to this property](<#(resource)%20logs.received%20%3E%20(model)%20received_get_response%20%3E%20(schema)>) #### LogsReceivedFields ##### [List fields](https://developers.cloudflare.com/api/typescript/resources/logs/subresources/received/subresources/fields/methods/get) 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 Link to this property
[Link to this property](<#(resource)%20logs.received.fields%20%3E%20(model)%20field_get_response%20%3E%20(schema)>)