Get system status

System status for any signed-in caller: component health, worker counts per class, queue depths and incidents. Counts only, the same for every caller, refreshed at most every 20 seconds.

GET /api/v1/status

Get system status

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/status \
  --header 'Authorization: Bearer <token>'

200

{
  "updatedAt": "<string>",
  "components": [
    {
      "id": "database",
      "label": "<string>",
      "state": "up",
      "note": "<string>"
    }
  ],
  "workers": [
    {
      "class": "cpu",
      "env": "dev",
      "pool": "cloud",
      "online": 1,
      "busy": 1,
      "incompleteMaps": 1
    }
  ],
  "queues": [
    {
      "source": "cloud",
      "kind": "<string>",
      "queued": 1,
      "oldestWaitSeconds": 1,
      "etaSeconds": 1
    }
  ],
  "incidents": [
    {
      "title": "<string>",
      "since": "<string>",
      "state": "investigating"
    }
  ]
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Response

200

application/json

System status.

updatedAt · string · required

components · object[] · required

Show child attributes

workers · object[] · required

Show child attributes

queues · object[] · required

Show child attributes

incidents · object[] · required

Show child attributes