LogoCloudflare API

Logs

logs

Logs

Control

logs.control

LogsControl

Cmb

logs.control.cmb

LogsControlCmb

Config

logs.control.cmb.config

Methods

Get Cmb Config -> Envelope<
CmbConfig
>
get/accounts/{account_id}/logs/control/cmb/config

Gets CMB config.

Update Cmb Config -> Envelope<
CmbConfig
>
post/accounts/{account_id}/logs/control/cmb/config

Updates CMB config.

Delete Cmb Config -> Envelope<unknown>
delete/accounts/{account_id}/logs/control/cmb/config

Deletes CMB config.

Domain types

CmbConfig = { allow_out_of_region_access, regions }
LogsControl

Retention

logs.control.retention

Methods

Get Log Retention Flag -> Envelope<{ flag }>
get/zones/{zone_id}/logs/control/retention/flag

Gets log retention flag for Logpull API.

Update Log Retention Flag -> Envelope<{ flag }>
post/zones/{zone_id}/logs/control/retention/flag

Updates log retention flag for Logpull API.

Logs

RayID

logs.rayid

Methods

Get Logs Ray IDs -> string | unknown
get/zones/{zone_id}/logs/rayids/{ray_id}

The /rayids api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).

Logs

Received

logs.received

Methods

Get Logs Received -> string | unknown
get/zones/{zone_id}/logs/received

The /received api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare's central data center. start is inclusive, and end is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z, then start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z and so on; the overlap will be handled properly.

LogsReceived

Fields

logs.received.fields

Methods

List Fields -> { key }
get/zones/{zone_id}/logs/received/fields

Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.