Upgrade to WebSocket for streaming exec/PTY

import requests

url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/ws"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.13-215-85-171.sslip.io/v1/machines/{id}/ws \
  --header 'Authorization: Bearer <token>'

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

WebSocket

Upgrade to WebSocket for streaming exec/PTY

Upgrades the HTTP connection to a WebSocket. The machine must exist. This endpoint is for authenticated exec/PTY lifecycle traffic. Public exposed-port and SSH websocket access is returned as websocket_url from POST /v1/machines/{id}/host when edge ingress is enabled. See docs/product/reference/websocket-protocol.md for the message format. The PTY control stream accepts RuntimeWsClientMessage frames and emits RuntimeWsServerMessage frames. PTY reconnect accepts exactly one of session_id or legacy pid; PTY input accepts exactly one of byte-safe data_base64 or legacy text data. PTY session_id and legacy pid reconnect are scoped to the current running machine execution and are not durable across hibernate/resume. The server sends WebSocket Ping frames every 15 seconds and closes after two missed Pong responses.

GET

machines

{id}

import requests

url = "https://api.13-215-85-171.sslip.io/v1/machines/{id}/ws"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.13-215-85-171.sslip.io/v1/machines/{id}/ws \
  --header 'Authorization: Bearer <token>'

{
  "error": "<string>",
  "error_detail": {
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Path Parameters

string

required

Machine ID (e.g. mch_a1b2c3d4)

Response

Switching Protocols (WebSocket upgrade)

Upgrade to a native lifecycle WebSocket stream Upgrade to WebSocket for direct volume watches

Overview

Endpoints

Upgrade to WebSocket for streaming exec/PTY

Authorizations

Path Parameters

Response