Externe toegang

Consolesessie openen

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

Opent een externe consolesessie bereikbaar vanaf het opgegeven client-IP en geeft URL en vervaltijd terug.

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"
  }
}

Autorisatie

Authorizationstringheaderverplicht
Organisatie-API-sleutel (org_...), gemaakt in de cloudconsole op https://cloud.serverside.com en één keer getoond, verstuurd als Authorization: Bearer <key>. Authenticeert als de organisatie.

Vereiste toestemming: organization.baremetal.console

Padparameters

idstring<uuid>verplicht

Body

application/json

clientIpAddressstringverplicht
IPv4- of IPv6-adres.
timeoutSecondsinteger<int32>verplicht
Grenzen:3600 <= x <= 86400

Antwoord

201 · application/json

Aangemaakt

successbooleanverplicht
Toegestane waarden:true
dataobject | nullverplicht