Skip to main content

SystemStatus

Current status of System. Required fields are status, components, checked_at.

statusStatus (string)required

Possible values: [ok, degraded, down, unknown]

components object[]required
  • Array [
    • nameName (string)required
    kindKind (string)required
    statusStatus (string)required

    Possible values: [ok, degraded, down, unknown]

    endpoint object
    anyOf
    string
    reachable object
    anyOf
    boolean
    workloads object[]
  • Array [
    • nameName (string)required
    kindKind (string)required

    Possible values: [statefulset, deployment]

    desiredDesired (integer)required
    readyReady (integer)required
  • ]
    • ha object
    anyOf
    boolean
    consumers object
    anyOf
  • Array [
    • groupGroup (string)required
    stateState (string)required
    lag objectrequired
    anyOf
    integer
  • ]
    • detail object
    anyOf
    string
  • ]
    • checked_atChecked At (string)required
    SystemStatus
    {
      "status": "ok",
      "components": [
        {
          "name": "string",
          "kind": "string",
          "status": "ok",
          "endpoint": "string",
          "reachable": true,
          "workloads": [
            {
              "name": "string",
              "kind": "statefulset",
              "desired": 0,
              "ready": 0
            }
          ],
          "ha": true,
          "consumers": [
            {
              "group": "string",
              "state": "string",
              "lag": 0
            }
          ],
          "detail": "string"
        }
      ],
      "checked_at": "string"
    }