API Reference

Logpush

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Edge

List Instant Logs jobs

client.logpush.edge.get(EdgeGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<InstantLogpushJob { destination_conf, fields, filter, 2 more } | null>

GET/zones/{zone_id}/logpush/edge/jobs

Create Instant Logs job

client.logpush.edge.create(EdgeCreateParams { zone_id, fields, filter, sample } params, RequestOptionsoptions?): InstantLogpushJob { destination_conf, fields, filter, 2 more } | null

POST/zones/{zone_id}/logpush/edge/jobs

ModelsExpand Collapse

InstantLogpushJob { destination_conf, fields, filter, 2 more }

destination_conf?: string

Unique WebSocket address that will receive messages from Cloudflare’s edge.

formaturi

maxLength4096

fields?: string

Comma-separated list of fields.

filter?: string

Filters to drill down into specific events.

sample?: number

The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.

session_id?: string

Unique session id of the job.