Create Logpush job - Cloudflare

Creates a new Logpush job for a zone.

Request

Path Params

zone_identifier

string

required

Body Params application/json

dataset

string | null

optional

Dataset to be pulled.

<= 256 characters

Example:

http_requests

Match pattern:

^[a-zA-Z0-9_\-]*$

destination_conf

string <uri>

required

Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

<= 4096 characters

Example:

s3://mybucket/logs?region=us-west-2

enabled

boolean

optional

Flag that indicates if the job was enabled.

Example:

false

frequency

enum<string> | enum<null>

optional

The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

Allowed values:

highlow

Default:

high

Example:

high

logpull_options

string <uri-reference> | null

optional

Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

<= 4096 characters

Example:

fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339

name

string | null

optional

Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.

<= 512 characters

Example:

example.com

Match pattern:

^[a-zA-Z0-9\-\.]*$

ownership_challenge

string

optional

Ownership challenge token to prove destination ownership.

<= 4096 characters

Example:

00000000000000000000

Match pattern:

^[a-zA-Z0-9/\+\.\-_]*$

Example

{
    "dataset": "http_requests",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "enabled": false,
    "frequency": "high",
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
    "name": "example.com",
    "ownership_challenge": "00000000000000000000"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create Logpush job response

application/json

Body

result

required

Any of

allOf {2}

One of

null

object

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Create Logpush job response failure