Skip to content
Praxrr

Refresh drift for one instance on demand

POST
/drift/{instanceId}
curl --request POST \
  --url https://example.com/api/v1/drift/1

Runs a fresh drift check for the instance on the request thread (not the scheduled queue) and returns the updated detail. Rate-limited per 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”

Drift re-checked

Media typeapplication/json
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
checkedAt
required
One of:
string format: date-time
contentCheckedAt
required
One of:
string format: date-time
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 in the resolved desired set (non-alerting).

integer
drift
required

Entities whose fields diverged (action = update).

Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
entityType
required
string
name
required

Entity display name (namespace-stripped).

string
action
required
string
Allowed values: create update delete unchanged
category
required
string
Allowed values: drift missing unmanaged
remoteId
required

Live Arr entity id, or null for a create/missing entity.

integer
nullable
fields
required

Field-level diff (current = live, desired = PCD); empty for create/delete.

Array<object>
object
field
required

Dot-notated field path

string
type
required
string
Allowed values: added changed removed
current
required
Any of:
string
desired
required
Any of:
string
missing
required

Managed entities absent on the Arr (action = create).

Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
entityType
required
string
name
required

Entity display name (namespace-stripped).

string
action
required
string
Allowed values: create update delete unchanged
category
required
string
Allowed values: drift missing unmanaged
remoteId
required

Live Arr entity id, or null for a create/missing entity.

integer
nullable
fields
required

Field-level diff (current = live, desired = PCD); empty for create/delete.

Array<object>
object
field
required

Dot-notated field path

string
type
required
string
Allowed values: added changed removed
current
required
Any of:
string
desired
required
Any of:
string
unmanaged
required

Live Arr entities not in the desired set (action = delete, non-alerting).

Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
entityType
required
string
name
required

Entity display name (namespace-stripped).

string
action
required
string
Allowed values: create update delete unchanged
category
required
string
Allowed values: drift missing unmanaged
remoteId
required

Live Arr entity id, or null for a create/missing entity.

integer
nullable
fields
required

Field-level diff (current = live, desired = PCD); empty for create/delete.

Array<object>
object
field
required

Dot-notated field path

string
type
required
string
Allowed values: added changed removed
current
required
Any of:
string
desired
required
Any of:
string
Example
{
  "arrType": "radarr",
  "status": "in-sync",
  "reason": "unreachable",
  "drift": [
    {
      "section": "qualityProfiles",
      "action": "create",
      "category": "drift",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ],
  "missing": [
    {
      "section": "qualityProfiles",
      "action": "create",
      "category": "drift",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ],
  "unmanaged": [
    {
      "section": "qualityProfiles",
      "action": "create",
      "category": "drift",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ]
}

400

Section titled “400”

Instance type is unsupported or the instance is disabled

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Instance not found

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

409

Section titled “409”

A drift check for this instance is already in progress

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

429

Section titled “429”

On-demand drift refresh is rate-limited for this instance

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to refresh drift

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}