Boot and iPXE

Set boot mode

PUT/v1/baremetal/{id}/boot-mode

Sets the service's boot mode and queues the switch reconfiguration the new mode needs.

curl --request PUT \
  --url https://api.serverside.com/v1/baremetal/{id}/boot-mode \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bootMode": "LOCAL_DISK"
}
'

{
  "success": true,
  "data": {
    "status": "APPLYING",
    "since": "2026-01-15T09:30:00Z",
    "failureCategory": "<string>",
    "degraded": {
      "consecutiveFailures": 123,
      "failureCategory": "<string>",
      "nextAttemptAt": "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.update

Path parameters

idstring<uuid>required

Body

application/json

bootModeenum<string>required
Allowed values:LOCAL_DISKPXE

Response

202 · application/json

Accepted

successbooleanrequired
Allowed values:true
dataobject | nullrequired