Vorgänge

Vorgang abrufen

GET/v1/baremetal/{id}/operations/{operationId}

Ruft einen Dienstvorgang mit seinen Fortschrittsmeldungen ab.

curl --request GET \
  --url https://api.serverside.com/v1/baremetal/{id}/operations/{operationId} \
  --header 'Authorization: Bearer <api-key>'

{
  "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>",
    "state": "CREATED",
    "endedAt": "2026-01-15T09:30:00Z",
    "failureCategory": "<string>",
    "updates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "at": "2026-01-15T09:30:00Z",
        "progress": 123,
        "message": "<string>"
      }
    ],
    "details": {
      "type": "DEPLOYMENT",
      "operatingSystem": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "name": "<string>"
      },
      "application": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "name": "<string>"
      },
      "raidVariant": "NONE",
      "username": "<string>"
    }
  }
}

Autorisierung

Authorizationstringheadererforderlich
Organisations-API-Schlüssel (org_...), in der Cloud-Konsole unter https://cloud.serverside.com erstellt und einmal angezeigt, gesendet als Authorization: Bearer <key>. Authentifiziert als Organisation.

Erforderliche Berechtigung: organization.baremetal.read

Pfadparameter

idstring<uuid>erforderlich
operationIdstring<uuid>erforderlich

Antwort

200 · application/json

OK

successbooleanerforderlich
Zulässige Werte:true
dataobject | nullerforderlich