API Reference

Logpush

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Edge

List Instant Logs jobs

logpush.edge.get(EdgeGetParams**kwargs) -> SyncSinglePage[Optional[InstantLogpushJob]]

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

Create Instant Logs job

logpush.edge.create(EdgeCreateParams**kwargs) -> InstantLogpushJob

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

ModelsExpand Collapse

class InstantLogpushJob: …

destination_conf: Optional[str]

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

formaturi

maxLength4096

fields: Optional[str]

Comma-separated list of fields.

filter: Optional[str]

Filters to drill down into specific events.

sample: Optional[int]

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: Optional[str]

Unique session id of the job.