Open an authenticated SSH WebSocket to a running node

GET

/v1/spot/nodes/{id}/ssh

const url = 'https://example.com/v1/spot/nodes/example/ssh';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/spot/nodes/example/ssh \
  --header 'Authorization: Bearer <token>'

Use nodus spot ssh NODE_ID with the private key matching a public SSH key installed on the node. Keep the private key on your machine. This endpoint upgrades HTTP to a WebSocket carrying binary SSH bytes; it does not return JSON or run a shell command itself. Send a bearer token with organization-wide spot:write access in the Authorization header. Project-restricted keys, browser Origin headers and query parameters are not accepted. The connection closes after node release or credential revocation is detected.

Authorizations

bearer

Parameters

Path Parameters

required

string

Header Parameters

Nodus-Org

string

Organization to select with a user token; API keys are already scoped.

Responses

101

Switching protocols to a binary WebSocket carrying SSH

400

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

401

Authentication failed

application/json

object

apiVersion

required

string

Allowed values: v1

code

required

integer

kind

required

string

Allowed values: Status

message

required

string

reason

required

string

status

required

string

Allowed values: Failure

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

403

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

404

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

409

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

429

Request rate limit or daily stream egress quota exceeded

application/json

object

apiVersion

required

string

Allowed values: v1

code

required

integer

kind

required

string

Allowed values: Status

message

required

string

reason

required

string

status

required

string

Allowed values: Failure

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

503

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}

default

Spot error or platform Status before the WebSocket upgrade

application/json

Any of:

object
object

object

current_price

number format: double

error

required

string

message

string

retry_after

integer format: int64

Example

{
  "apiVersion": "v1",
  "kind": "Status",
  "status": "Failure"
}