Cloudflare API | Logpush

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.

Logpush Datasets

Jobs

logpush.datasets.jobs

Methods

List Logpush Jobs For A Dataset -> Envelope<Array<

LogpushJob

get/{account_or_zone}/{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 -> Envelope<Array<

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/{account_or_zone}/{account_or_zone_id}/logpush/jobs

Creates a new Logpush job for an account or zone.

Delete Logpush Job -> Envelope<{ id }>

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

Deletes a Logpush job.

Get Logpush Job Details -> Envelope<

LogpushJob

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

Gets the details of a Logpush job.

List Logpush Jobs -> SinglePage<

LogpushJob

get/{account_or_zone}/{account_or_zone_id}/logpush/jobs

Lists Logpush jobs for an account or zone.

Update Logpush Job -> Envelope<

LogpushJob

put/{account_or_zone}/{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-4428, 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/{account_or_zone}/{account_or_zone_id}/logpush/ownership

Gets a new ownership challenge sent to your destination.

Validate Ownership Challenge -> Envelope<

OwnershipValidation

post/{account_or_zone}/{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/{account_or_zone}/{account_or_zone_id}/logpush/validate/destination

Validates destination.

Check Destination Exists -> Envelope<{ exists }>

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

Checks if there is an existing job with a destination.

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

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

Validates logpull origin with logpull_options.