Skip to content
StratumStratum Docs

Platform Health pack status snapshot.

GET
/v1/observability/admin/platform-health
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/observability/admin/platform-health \
  --header 'Authorization: Bearer <token>'

Cedar action observability:ReadSubstrate. Returns the pack manifest with per-component state (installed | operator-edited | missing), the pack version, the last-reconciled timestamp, and a pack-level health rollup. The snapshot is computed live against the store on every call no caching beyond the reconciler’s own in-memory tick tracking. 503 means the pack reconciler isn’t wired yet (early boot or intentional opt-out).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Pack status snapshot.

Media typeapplication/json

Platform Health pack snapshot. Returned by GET /v1/observability/admin/platform-health.

object
packVersion
required

Pack version currently shipped by this controlplane binary.

string
lastReconciledAt

When the pack reconciler last completed a tick. Absent until the first run.

string format: date-time
components
required
Array<object>
object
componentId
required

Stable pack-component handle; constant across pack versions.

string
kind
required
string
Allowed values: dashboard alarm log_group
displayName
string
state
required

Installed = pack-stamped + content matches what shipped; operator-edited = pack-stamped + content diverged (the skipped_operator_edit path fired); missing = manifest declares it but no row carries the component_id label.

string
Allowed values: installed operator-edited missing
packVersionPresent

Pack_version label on the row, empty when state=missing.

string
packVersionExpected
required

Pack version this controlplane binary would install.

string
rowId

ID of the underlying dashboard / alarm / log-group row. Empty when state=missing.

string
suffixedRowId

. When state=operator-edited AND the pack reconciler has published a SUFFIX reference copy of the embedded body at “-v”, this is its row id. Empty when state != operator-edited OR when the reconciler hasn’t yet ticked since the divergence. The UI offers a “view what we shipped” link pointing at this row.

string
rollup
required
object
firingAlarmCount
required

Number of pack-owned alarms whose state is alarm.

integer
worstAlarmState

Worst alarm state across pack alarms (alarm > pending > insufficient_data > ok). Empty when no pack alarms exist.

string
oldestUnackedAt

When the longest-firing pack alarm entered alarm (alarms have no acknowledgement, so every firing alarm is unacked). Absent when none fires.

string format: date-time

Example 

{
  "packVersion": "1.0.0",
  "components": [
    {
      "componentId": "dash-node-substrate",
      "kind": "dashboard",
      "state": "installed"
    }
  ]
}

503

Section titled “503”

Upstream temporarily unavailable (driver / scheduler / dependency).

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}