Logs API

Build and deploy logs of a deployment

Without follow returns the persisted lines as {items:[{id,stream,line,createdAt}]} (at most 10,000 lines). With follow=true streams data: {stream,line,ts} until the deployment finishes, then event: end. The debug stream (the agent's verbose trace: docker calls, health probe attempts, route changes, timings; at most 500 lines) is left out unless streams asks for it.

Download a deployment's build and deploy log as a file

The persisted lines of the deployment (at most 10,000, plus 500 debug lines when asked for) as format=txt (default; <time> [<stream>] <line>, runtime lines without the tag) or format=ndjson ({ts, stream, line} per line), in the order they were recorded, optionally limited to a from/to time range. Secret values are redacted. Audited as deployment.logs.download.

Merged runtime logs of every service of an environment

Same shape as the service log endpoint; entries also carry serviceId and serviceName.

Stored runtime logs of an environment

The same as the service endpoint for every service of the environment, merged by time. Entries carry serviceId and serviceName. Services whose server is offline are listed in unavailable instead of failing the request.

List log drains

Destinations the servers ship runtime logs to. Credentials are never returned; servers carries the drain's health as each server's agent reports it. Requires the admin scope.

Add a log drain

Kinds: loki (push URL, tenant, labels; basic auth or bearer token), otlp (OTLP/HTTP logs URL; bearer token and/or headers), syslog (RFC 5424 over UDP, TCP or TCP+TLS) and http (JSON batches to any intake: Datadog, Better Stack, Axiom; credentials as headers, bearer or basic). Every connected server ships its lines from its own host, starting from the moment the drain is saved. Requires the admin scope.

Get a log drain

Update a log drain

Omitted fields stay as they are; empty credentials keep the stored ones (secrets.clear removes some). The kind cannot change.

Delete a log drain

Servers stop shipping and forget the drain's position.

Send a test line through a drain

Sends one test line from a connected server's agent, which is where reachability and credentials count, and returns the outcome (ok, a message, the HTTP status). The result is also kept on the drain's test state. Works on a disabled drain.

A server's log history settings

Capture on or off, retention days and size caps, with the usage the agent last reported.

Change a server's log history settings

Retention 1-90 days (default 7); size caps of at least 32 MB (defaults 500 MB per service, 5 GB per server; the oldest lines go first). The agent applies them at once.

Runtime logs of a service

Without follow returns {items:[{ts,line}]}. With follow=true streams server-sent events data: {ts,line,serviceId}. Secret values are redacted. 503 server_offline when the server is not connected.

Download a service's stored runtime logs as a file

The service's runtime log from the server's own history (7 days by default) as format=txt (default; one <time> <line> per line) or format=ndjson ({ts, stream, replica, deploymentId, line} per line), oldest first, within an optional from/to range and q filter. Secret values are redacted exactly as in the log view. At most 200,000 lines: a longer range ends with a truncation note, so narrow it. The history comes from the server's agent: 503 server_offline while it is offline, 409 history_disabled when capture is off. Audited as service.logs.download.

Stored runtime logs of a service

A page of the service's runtime log from the server's own history (7 days by default), within an optional time range, filtered by the log search language. The server's agent answers, so history is unavailable (503 server_offline) while the server is offline. Secret values are redacted. Page with nextCursor; partial: true means the scan stopped early and the cursor continues it.

Output of a task run

Without follow returns the stored lines as {items:[{id,stream,line,createdAt}]} (redacted, at most 10,000 lines). With follow=true streams data: {stream,line,ts} until the run finishes, then event: end with {status,exitCode}.