Operations

Deploy operating system

POST/v1/baremetal/{id}/deploy

Starts a deployment on the service and returns the created operation, which continues after the response.

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

{
  "success": true,
  "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>"
  }
}

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.deploy

Path parameters

idstring<uuid>required

Body

application/json

imagestring | null
usernamestring | null
passwordstring | null
sshKeyIdsstring<uuid>[] | null
raidVariantenum<string>
Allowed values:NONERAID0RAID1RAID5RAID6RAID10
applicationstring | null
applicationMetadataobject | null
cloudInitstring | null

Response

201 · application/json

Created

successbooleanrequired
Allowed values:true
dataobject | nullrequired

Authorizations

Path parameters

Body

Response

Footer