Skip to main content
GET
/
api
/
v1
/
vm
/
{vm_id}
/
logs
cURL
curl --request GET \
  --url https://api.example.com/api/v1/vm/{vm_id}/logs \
  --header 'Authorization: Bearer <token>'
{
  "entries": [
    {
      "data_b64": "<string>",
      "stream": "stdout",
      "timestamp": "<string>",
      "exec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "eof": true,
  "next_offset": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vm_id
string<uuid>
required

VM ID

Query Parameters

​
offset
integer<int64>

Byte offset into the log file (default: 0)

Required range: x >= 0
​
max_entries
integer<int32>

Maximum number of log entries to return

Required range: x >= 0
​
stream
string

Filter by 'stdout' or 'stderr'

Response

Exec logs retrieved

Response for exec log tail requests.

​
entries
object[]
required

Returned log entries.

​
eof
boolean
required

True when the end of file was reached.

​
next_offset
integer<int64>
required

Next byte offset to continue from.

Required range: x >= 0