DEdepot
CIService

Follows a job attempt's persisted log lines, streaming new lines while the attempt runs.

The response is a Connect/gRPC server stream, not raw text. Consume it with a generated client or a decoder that understands stream framing. Every response reports the attempt's current status. Responses that carry a log line also include nextCursor.

To resume a dropped stream, save the newest nextCursor and send it as cursor on a new request. The new stream picks up after the last line you received. The stream ends on its own once the attempt has finished, failed, or been cancelled and all persisted lines have been sent.

post/depot.ci.v1.CIService/StreamJobAttemptLogs

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

attemptIdstring

Unique identifier for the job attempt. Set exactly one of attemptId or jobId.

cursorstring

Opaque cursor returned by a previous stream response for the same target. Omit it to stream from the first persisted line.

jobIdstring

Unique identifier for a CI job. The stream resolves it to that job's latest attempt. Set exactly one of attemptId or jobId.

Response

Success

nextCursorstring

Opaque cursor to resume after the emitted line. Set on responses that carry a line. Persist the newest value and send it as cursor on a later request.

attemptStatusstring

Current state of the attempt. Can be "queued", "waiting", "running", "finished", "failed", or "cancelled".

Changes

No recorded changes to this operation across all 1 revision of this API.