Skip to Content

Logs

The logs operations of the v1 API.

GET
/v1/clusters/{cluster_id}/apps/{app_id}/builds/{build_id}/logs

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Cursor paginated: pass next_cursor back as cursor until it is null. While the build runs, has_more stays true and the cursor can be polled for new lines. Build log lines carry no timestamps.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The application UUID

Formatuuid
build_id*string

The build UUID

Formatuuid

Query Parameters

cursor?|

next_cursor of the previous page.

limit?|

Lines per page, 1 to 5000 (default 500).

Formatuint32
Range0 <= value

Response Body

A page of build log lines

application/json
  1. response

A page of a build's log lines, in order.

complete*boolean

The build has ended, so its log is final.

data*array<string>

Complete lines, in order. A running build's unfinished last line is held back.

has_more*boolean

More lines follow, or the build is still running (poll next_cursor).

next_cursor?|

Pass as cursor for the next page; null once the log is fully read.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/builds/00000000-0000-4000-8000-000000000003/logs' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "complete": true,  "data": [    "string"  ],  "has_more": true,  "next_cursor": "string"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/logs

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Cursor paginated: pass next_cursor back as cursor, with the same since and until, until has_more is false. Lines are kept for the cluster's log retention. There is no live tail on this API.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The application UUID

Formatuuid

Query Parameters

cursor?|

next_cursor of the previous page.

limit?|

Lines per page, 1 to 1000 (default 100).

Formatuint32
Range0 <= value
pod?|

Only lines of this pod.

since?|

Start of the range (RFC 3339, inclusive). Default: an hour before until.

Formatdate-time
until?|

End of the range (RFC 3339, exclusive). Default: now. Pass it when paging, so every page reads the same range. At most 31 days after since.

Formatdate-time

Response Body

A page of log lines

application/json
  1. response

A page of an app's log lines, oldest first.

data*array<>

The lines, oldest first.

has_more*boolean

More lines in the range follow this page.

next_cursor?|

Pass as cursor (with the same range) for the next page; null on the last page.

retained_from?|

Lines older than this were removed (by ingest time, so approximate); null when the app lost none.

Formatdate-time
retained_reason?||

Why lines before retained_from are gone; null with it.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/logs' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "container": "string",      "message": "string",      "pod": "string",      "severity": "string",      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string",  "retained_from": "2019-08-24T14:15:22Z",  "retained_reason": "size"}

On this page