Skip to content
Praxrr

Config-health detail for one instance

GET
/config-health/{instanceId}
curl --request GET \
  --url https://example.com/api/v1/config-health/1

Live overall health plus a per-quality-profile breakdown with per-criterion contributions and non-judgmental suggestions for a single instance.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
instanceId
required
integer

Arr instance id

Responses

Section titled “Responses”

200

Section titled “200”

Instance health detail

Media typeapplication/json
object
instanceId
required
integer
instanceName
required
string
arrType
required
string
Allowed values: radarr sonarr lidarr
engineVersion
required
string
generatedAt
required
string format: date-time
overall
required

A scored unit (whole instance or one profile) — the rollup number, its band, and the breakdown.

object
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
criteria
required
Array<object>

One criterion’s contribution to a scored unit.

object
id
required

Criterion id — one of completeness, drift, coherence, compatibility, trash_alignment.

string
label
required
string
score
required
One of:
integer
<= 100
weight
required
integer
contribution
required
integer
detail
required
Array<string>
suggestions
required
Array<object>

A non-judgmental remediation line rendered through the shared narration surface.

object
headline
required
string
detail
required
Array<string>
tone
required

Presentation hint for a suggestion; health tone never exceeds warning.

string
Allowed values: neutral info warning danger
templateVersion
required
string
suggestions
required
Array<object>

A non-judgmental remediation line rendered through the shared narration surface.

object
headline
required
string
detail
required
Array<string>
tone
required

Presentation hint for a suggestion; health tone never exceeds warning.

string
Allowed values: neutral info warning danger
templateVersion
required
string
profiles
required
Array
object
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
criteria
required
Array<object>

One criterion’s contribution to a scored unit.

object
id
required

Criterion id — one of completeness, drift, coherence, compatibility, trash_alignment.

string
label
required
string
score
required
One of:
integer
<= 100
weight
required
integer
contribution
required
integer
detail
required
Array<string>
suggestions
required
Array<object>

A non-judgmental remediation line rendered through the shared narration surface.

object
headline
required
string
detail
required
Array<string>
tone
required

Presentation hint for a suggestion; health tone never exceeds warning.

string
Allowed values: neutral info warning danger
templateVersion
required
string
suggestions
required
Array<object>

A non-judgmental remediation line rendered through the shared narration surface.

object
headline
required
string
detail
required
Array<string>
tone
required

Presentation hint for a suggestion; health tone never exceeds warning.

string
Allowed values: neutral info warning danger
templateVersion
required
string
name
required
string
Example
{
  "arrType": "radarr",
  "overall": {
    "band": "healthy",
    "criteria": [
      {
        "suggestions": [
          {
            "tone": "neutral"
          }
        ]
      }
    ],
    "suggestions": [
      {
        "tone": "neutral"
      }
    ]
  },
  "profiles": [
    {
      "band": "healthy",
      "criteria": [
        {
          "suggestions": [
            {
              "tone": "neutral"
            }
          ]
        }
      ],
      "suggestions": [
        {
          "tone": "neutral"
        }
      ]
    }
  ]
}

400

Section titled “400”

Invalid instance id

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Instance not found or not sync-capable

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}