Operations

Deploy operating system

POST/v1/services/baremetal/{id}/operations/deploy

curl --request POST \
  --url https://api.serverside.com/v1/services/baremetal/{id}/operations/deploy \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operatingSystemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "username": "<string>",
  "password": "<string>",
  "sshKeyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "raidVariant": "NONE",
  "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicationMetadata": "<string>",
  "cloudInit": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "DEPLOYMENT",
    "progress": 123,
    "startedAt": "2026-01-15T09:30:00Z",
    "lastProgressAt": "2026-01-15T09:30:00Z",
    "lastProgressMessage": "<string>"
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisations

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

Paramètres de chemin

idstring<uuid>obligatoire

Corps

application/json

operatingSystemIdstring<uuid> | null
usernamestring | null
passwordstring | null
sshKeyIdsstring<uuid>[] | null
raidVariantenum<string>
Valeurs autorisées :NONERAID0RAID1RAID5RAID6RAID10
applicationIdstring<uuid> | null
applicationMetadatastring | null
cloudInitstring | null

Réponse

200 · application/json

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

Autorisations

Paramètres de chemin

Corps

Réponse

Pied de page