API Reference
OIDC
Platform

Log Streams

AdminUpdated Sep 11, 2026

Log Streams

Backend API — secret key (Authorization: Bearer sk_…).

6 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/log_streams

log_streams:read

List log streams (event forwarding to Datadog, Splunk or a generic HTTP sink). Secret values are never returned, only has_* markers.

POST /v1/log_streams

log_streams:write

Create a log stream. destination secrets (api_key / token / auth headers) are write-only; the cursor starts at the current event so only new events forward.

GET /v1/log_streams/:id

log_streams:read

Read one log stream, including its forwarding status, cursor and last error. Reports secret markers only, never their values.

PATCH /v1/log_streams/:id

log_streams:write

Update a log stream's name, destination, event_filter, enabled flag, or status (active/paused). A secret left out of destination is preserved.

DELETE /v1/log_streams/:id

log_streams:write

Delete a log stream. Forwarding stops immediately; no further events are sent to the sink.

POST /v1/log_streams/:id/test

log_streams:write

Send one synthetic event to the sink with the stream's real credentials and return the sink's status. Touches no real event and never moves the cursor.

Was this page helpful?