Skip to main content

Node Console

Access node console via WebSocket connection.

Request​

GET /api/v1/pve/node/:clusterId/:node/console
Authorization: Bearer <token>

Path Parameters​

ParameterTypeDescription
clusterIdintCluster ID
nodestringNode name

WebSocket Connection​

After successful connection, a WebSocket connection will be established:

ws://localhost:8000/api/v1/pve/node/:clusterId/:node/console?token=<token>

Message Format​

Send Command​

{
  "type": "input",
  "data": "ls -la\n"
}

Receive Output​

{
  "type": "output",
  "data": "total 100\n..."
}

Usage Example​

const ws = new WebSocket('ws://localhost:8000/api/v1/pve/node/1/pve-node-01/console?token=xxx');

ws.onmessage = (event) => {
  const message = JSON.parse(event.data);
  if (message.type === 'output') {
    console.log(message.data);
  }
};

ws.send(JSON.stringify({
  type: 'input',
  data: 'ls -la\n'
}));