Skip to content
Praxrr

Drift detection summary

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

Returns the latest drift status for every enabled, sync-capable Arr instance, plus aggregate totals and the drift check settings. Instances that have never been checked are synthesized as never-checked. Degraded per-instance statuses (unreachable, unauthorized, error) are carried in the 200 body — this endpoint returns 500 only on an internal error.

Responses

Section titled “Responses”

200

Section titled “200”

Drift summary

Media typeapplication/json
object
generatedAt
required
string format: date-time
settings
required
object
enabled
required
boolean
intervalMinutes
required
integer
>= 5 <= 525600
lastRunAt
required
One of:
string format: date-time
nextRunAt
required
One of:
string format: date-time
backoffUntil
required
One of:
string format: date-time
errorCount
required
integer
totals
required
object
instances
required
integer
inSync
required
integer
drifted
required
integer
unreachable
required
integer
unauthorized
required
integer
error
required
integer
neverChecked
required
integer
instances
required
Array<object>
object
instanceId
required
integer
instanceName
required
string
arrType
required
string
Allowed values: radarr sonarr lidarr
status
required

Drift status as surfaced in the summary. Extends DriftStatus with the synthesized never-checked value for enabled instances that have no stored row yet.

string
Allowed values: in-sync drifted unreachable unauthorized error never-checked
reason
required
One of:

Sanitized closed reason for a non-in-sync outcome.

string
Allowed values: unreachable timeout unauthorized invalid_response not_configured cache_not_ready rate_limited error
detectedVersion
required
One of:
string
counts
required
object
drifted
required

Managed entities whose fields diverged on the Arr (alerting).

integer
missing
required

Managed entities absent on the Arr (alerting).

integer
unmanaged
required

Live Arr entities not owned by Praxrr and not in the resolved desired set (non-alerting).

integer
prune
required

Ledger-owned entities pending reviewed removal (non-alerting).

integer
checkedAt
required
One of:
string format: date-time
contentCheckedAt
required
One of:
string format: date-time
Example
{
  "instances": [
    {
      "arrType": "radarr",
      "status": "in-sync",
      "reason": "unreachable"
    }
  ]
}

500

Section titled “500”

Failed to build drift summary

Media typeapplication/json
object
error
required

Error message

string
code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string
Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed
Example
{
  "code": "cleanup_failed"
}