Skip to content
ReflexDB

Control plane health

GET
/system/health
 
curl --request GET \
  --url https://api.reflexdb.cloud/v1/system/health \
  --header 'Authorization: Bearer <token>'

Returns ECS service revisions, SQS queue depths, sidecar health, and recent build history per region. Useful for monitoring the control plane itself.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
services
required
Array<object>
object
name
required
string
runningRevision
required
integer
latestRevision
required
integer
runningCount
required
integer
desiredCount
required
integer
builderServices
required
Array<object>
object
region
required
string
runningRevision
required
integer
latestRevision
required
integer
runningCount
required
integer
desiredCount
required
integer
queues
required
Array<object>
object
region
required
string
build
required
object
waiting
required
integer
inFlight
required
integer
deploy
required
object
waiting
required
integer
inFlight
required
integer
buildResults
required
object
waiting
required
integer
inFlight
required
integer
dlq
required
object
waiting
required
integer
deployDlq
required
object
waiting
required
integer
sidecarHealth
required
Array<object>
object
region
required
string
ok
required
boolean
latencyMs
integer
nullable
recentBuilds
required
Array<object>
object
region
required
string
builds
required
Array<object>
object
id
required
string
status
required
string
startedAt
string
nullable
durationMs
integer
nullable
logsUrl
string
nullable
Example generated
{
  "services": [
    {
      "name": "example",
      "runningRevision": 1,
      "latestRevision": 1,
      "runningCount": 1,
      "desiredCount": 1
    }
  ],
  "builderServices": [
    {
      "region": "example",
      "runningRevision": 1,
      "latestRevision": 1,
      "runningCount": 1,
      "desiredCount": 1
    }
  ],
  "queues": [
    {
      "region": "example",
      "build": {
        "waiting": 1,
        "inFlight": 1
      },
      "deploy": {
        "waiting": 1,
        "inFlight": 1
      },
      "buildResults": {
        "waiting": 1,
        "inFlight": 1
      },
      "dlq": {
        "waiting": 1
      },
      "deployDlq": {
        "waiting": 1
      }
    }
  ],
  "sidecarHealth": [
    {
      "region": "example",
      "ok": true,
      "latencyMs": 1
    }
  ],
  "recentBuilds": [
    {
      "region": "example",
      "builds": [
        {
          "id": "example",
          "status": "example",
          "startedAt": "example",
          "durationMs": 1,
          "logsUrl": "example"
        }
      ]
    }
  ]
}