Skip to main content
POST
/
api
/
v1
/
vm
/
{vm_id}
/
exec
/
stream
/
attach
cURL
curl --request POST \
  --url https://api.example.com/api/v1/vm/{vm_id}/exec/stream/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cursor": 1,
  "from_latest": true
}
'
{
  "error": "<string>",
  "success": true
}

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

Body

application/json

Request body for POST /api/vm/{vm_id}/exec/stream/attach

​
exec_id
string<uuid>
required

Identifier of the exec stream session to reattach to.

​
cursor
integer<int64> | null

Optional cursor to resume from (exclusive). If omitted, the full retained backlog is replayed.

Required range: x >= 0
​
from_latest
boolean | null

Start streaming after the latest retained chunk (ignores cursor).

Response

NDJSON stream replaying from cursor