Skip to main content
GET
Get instance logs

Authorizations

Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Path Parameters

id
string
required

A resource path like 'sfc:instance:acme:prod:my-instance' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (inst_[0-9a-zA-Z_-]{1,21}|vm_[0-9a-zA-Z_-]{1,21})|(sfc:instance:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"inst_k3R-nX9vLm7Qp2Yw5Jd8F"

Query Parameters

seqnum_before
integer<u-int64>

Return logs with seqnum less than or equal to this value.

Required range: x >= 0
seqnum_after
integer<u-int64>

Return logs with seqnum greater than or equal to this value.

Required range: x >= 0
realtime_timestamp_before
integer<int64>

Due to clock synchronization, some earlier log messages may have a realtime timestamp after this value. Unix timestamp.

Example:

1738972800

realtime_timestamp_after
integer<int64>

Due to clock synchronization, some later log messages may have a realtime timestamp before this value. Unix timestamp.

Example:

1738972800

sort_by
enum<string>
Available options:
seqnum,
-seqnum
limit
integer<u-int64>
default:100
Required range: 1 <= x <= 2500
starting_after
string

Set to the response's cursor to fetch the next page.

Pattern: ^logc_[A-Za-z0-9_-]+$
Example:

"logc_gqXR7s0Kj5mHvE2wNpLc4Q"

ending_before
string

Set to the response's cursor to fetch the previous page.

Pattern: ^logc_[A-Za-z0-9_-]+$
Example:

"logc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated log chunks.

object
string
default:list
required
read-only
Allowed value: "list"
has_more
boolean
required
data
object[]
required
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^logc_[A-Za-z0-9_-]+$
Example:

"logc_gqXR7s0Kj5mHvE2wNpLc4Q"