Skip to content
GitHub

The build's log: from the build pod while it runs, from the kept tail after. With `follow=true`, a live stream of new lines.

GET
/api/v1/projects/{project}/environments/{environment}/apps/{app}/builds/{build}/logs
curl --request GET \
--url https://example.com/api/v1/projects/example/environments/example/apps/example/builds/example/logs
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

build
required
string

Build id

follow
boolean

Keep the connection open and send new lines as text/event-stream: line events (a [LogLine]) and an end event (a [LogEnd]) when the build’s log stops.

The log as text; with follow, text/event-stream of line (LogLine) and end (LogEnd) events

Media typetext/plain
string
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}

Too many followed logs open

Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}