Skip to content
Console
On this page

Read logs on a build

Reads a page of a build's log lines, oldest first.

Reads a page of a build's log lines, oldest first. With wait, an empty page on a running build waits up to that long for new lines, so a client follows the log by passing each next_page_token back.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:readLogs
  • Scope build:read
  • Effect read — nothing is written.
  • Collection builds
  • Query page_size, page_token, wait

Request

FieldTypeWhat it is
namestringThe name of the build. Required.
page_sizeint32At most this many lines; default 500, clamped to 5000.
page_tokenstringnext_page_token of the previous page.
waitdurationOn a running build, wait up to this long (at most 30s) for new lines before returning an empty page.

Response

FieldTypeWhat it is
linesBuildLogLine[]The page, oldest first.
next_page_tokenstringThe token of the next page. It is set while the build can still write, so a follower keeps polling; empty once the build is final and every line was read.

BuildLogLine

FieldTypeWhat it is
write_timetimestampWhen the line was written. Output only.
streamstringstdout or stderr. Output only.
textstringThe line, without its trailing newline. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:readLogs" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"