Remote access

Create KVM session

POST/v1/services/baremetal/{id}/ikvm

curl --request POST \
  --url https://api.serverside.com/v1/services/baremetal/{id}/ikvm \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientIpAddress": "<string>",
  "timeoutHours": 123
}
'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "url": "<string>",
    "ipmiUsername": "<string>",
    "ipmiPassword": "<string>",
    "forwardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisierung

X-API-KEYstringheadererforderlich
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Pfadparameter

idstring<uuid>erforderlich

Body

application/json

clientIpAddressstringerforderlich
timeoutHoursinteger<int32>erforderlich

Antwort

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject