Skip to main content
GET
Step logs

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

step_id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Query Parameters

offset
integer | null
default:0

Where to start, in lines. Negative counts back from the end, so -200 is the last 200 lines. How a viewer opens on the newest output without reading the log first

limit
integer
default:200
Required range: 1 <= x <= 1000
node_id
string
required

Whose copy of the step's log to read. The file is one per node

Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

A page of log lines

lines
object[]
required
total
integer
required

Total lines in the log, ignoring offset/limit

offset
integer
required
limit
integer
required
source
enum<string> | null
required

Where the log was read from. node is live; repository can be a few seconds behind. null means nothing has been logged

Available options:
repository,
node,
null
whole_step
boolean
default:false
required

True when the log could not be narrowed to this task. A plain-text log from before lines carried one, so these are every task this machine ran on the step