Remote access

Open console session

POST/v1/baremetal/{id}/console-sessions

Opens a remote console session reachable from the given client IP address and returns its URL and expiry.

curl --request POST \
  --url https://api.serverside.com/v1/baremetal/{id}/console-sessions \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientIpAddress": "203.0.113.10",
  "timeoutSeconds": 3600
}
'

{
  "success": true,
  "data": {
    "url": "<string>",
    "ipmiUsername": "<string>",
    "ipmiPassword": "<string>",
    "forwardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startedAt": "2026-01-15T09:30:00Z",
    "expiresAt": "2026-01-15T09:30:00Z"
  }
}

Authorizations

Authorizationstringheaderrequired
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Required permission: organization.baremetal.console

Path parameters

idstring<uuid>required

Body

application/json

clientIpAddressstringrequired
IPv4 or IPv6 address.
timeoutSecondsinteger<int32>required
Limits:3600 <= x <= 86400

Response

201 · application/json

Created

successbooleanrequired
Allowed values:true
dataobject | nullrequired