Skip to content
Praxrr

Fleet config-health summary

GET
/config-health/summary
curl --request GET \
  --url https://example.com/api/v1/config-health/summary

Live per-instance overall health score and band for every enabled, sync-capable Arr instance, plus aggregate totals and a settings snapshot. Degraded/never-checked states are carried in the 200 body (per-instance band), not as an HTTP error.

Responses

Section titled “Responses”

200

Section titled “200”

Fleet health summary

Media typeapplication/json
object
engineVersion
required
string
generatedAt
required
string format: date-time
totals
required
object
instances
required
integer
healthy
required
integer
attention
required
integer
needsReview
required
integer
unknown
required
integer
averageScore
required
One of:
integer
<= 100
settings
required
object
enabled
required
boolean
intervalMinutes
required
integer
>= 5
instances
required
Array<object>
object
instanceId
required
integer
instanceName
required
string
arrType
required
string
Allowed values: radarr sonarr lidarr
score
required
integer
<= 100
band
required

Health band derived from the 0–100 rollup. unknown means every enabled criterion was skipped.

string
Allowed values: healthy attention needs-review unknown
generatedAt
required
string format: date-time
Example
{
  "instances": [
    {
      "arrType": "radarr",
      "band": "healthy"
    }
  ]
}

500

Section titled “500”

Internal error

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}