Cloudflare API | Logpush › Datasets › Fields

Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Logs Write Logs Read

path Parameters

dataset_id:

(default: "http_requests")

Name of the dataset. A list of supported datasets can be found on the Developer Docs.

"access_requests"

"audit_logs"

"biso_user_actions"

"casb_findings"

"device_posture_results"

"dlp_forensic_copies"

"dns_firewall_logs"

"dns_logs"

"email_security_alerts"

"firewall_events"

"gateway_dns"

"gateway_http"

"gateway_network"

"http_requests"

"magic_ids_detections"

"nel_reports"

"network_analytics_logs"

"page_shield_events"

"sinkhole_http_logs"

"spectrum_events"

"ssh_logs"

"workers_trace_events"

"zaraz_events"

"zero_trust_network_sessions"

account_id: string

Optional

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id: string

Optional

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

success: true

Whether the API call was successful.

result: unknown

Optional

Request example

curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/logpush/datasets/$DATASET_ID/fields \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {}
}

Logpush Datasets

Jobs

logpush.datasets.jobs

Methods

List Logpush Jobs For A Dataset -> SinglePage<

LogpushJob

get/{accounts_or_zones}/{account_or_zone_id}/logpush/datasets/{dataset_id}/jobs

Lists Logpush jobs for an account or zone for a dataset.

Logpush

Edge

logpush.edge

Methods

Create Instant Logs Job -> Envelope<

InstantLogpushJob

post/zones/{zone_id}/logpush/edge

Creates a new Instant Logs job for a zone.

List Instant Logs Jobs -> SinglePage<

InstantLogpushJob

get/zones/{zone_id}/logpush/edge

Lists Instant Logs jobs for a zone.

Domain types

InstantLogpushJob = { destination_conf, fields, filter, 2 more... }

Logpush

Jobs

logpush.jobs

Methods

Create Logpush Job -> Envelope<

LogpushJob

post/{accounts_or_zones}/{account_or_zone_id}/logpush/jobs

Creates a new Logpush job for an account or zone.

Delete Logpush Job -> Envelope<{ id }>

delete/{accounts_or_zones}/{account_or_zone_id}/logpush/jobs/{job_id}

Deletes a Logpush job.

Get Logpush Job Details -> Envelope<

LogpushJob

get/{accounts_or_zones}/{account_or_zone_id}/logpush/jobs/{job_id}

Gets the details of a Logpush job.

List Logpush Jobs -> SinglePage<

LogpushJob

get/{accounts_or_zones}/{account_or_zone_id}/logpush/jobs

Lists Logpush jobs for an account or zone.

Update Logpush Job -> Envelope<

LogpushJob

put/{accounts_or_zones}/{account_or_zone_id}/logpush/jobs/{job_id}

Updates a Logpush job.

Domain types

LogpushJob = { id, dataset, destination_conf, 12 more... }

OutputOptions = { batch_prefix, batch_suffix, CVE-2021-44228, 9 more... }

The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored.

Logpush

Ownership

logpush.ownership

Methods

Get Ownership Challenge -> Envelope<{ filename, message, valid }>

post/{accounts_or_zones}/{account_or_zone_id}/logpush/ownership

Gets a new ownership challenge sent to your destination.

Validate Ownership Challenge -> Envelope<

OwnershipValidation

post/{accounts_or_zones}/{account_or_zone_id}/logpush/ownership/validate

Validates ownership challenge of the destination.

Domain types

OwnershipValidation = { valid }

Logpush

Validate

logpush.validate

Methods

Validate Destination -> Envelope<{ message, valid }>

post/{accounts_or_zones}/{account_or_zone_id}/logpush/validate/destination

Validates destination.

Check Destination Exists -> Envelope<{ exists }>

post/{accounts_or_zones}/{account_or_zone_id}/logpush/validate/destination/exists

Checks if there is an existing job with a destination.

Validate Origin -> Envelope<{ message, valid }>

post/{accounts_or_zones}/{account_or_zone_id}/logpush/validate/origin

Validates logpull origin with logpull_options.