Refresh drift for one instance on demand

POST

/drift/{instanceId}

const url = 'https://example.com/api/v1/drift/1';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Path Parameters

instanceId

required

integer

Arr instance ID

Responses

200

Drift re-checked

application/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:

string
null

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
null

string

checkedAt

required

One of:

string
null

string format: date-time

contentCheckedAt

required

One of:

string
null

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 owned by Praxrr and not in the resolved desired set (non-alerting).

integer

prune

required

Ledger-owned entities pending reviewed removal (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

Changed or missing desired entities are alerting; unmanaged entities and pending managed prunes are non-alerting.

string

Allowed values: drift missing unmanaged prune

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

Changed or missing desired entities are alerting; unmanaged entities and pending managed prunes are non-alerting.

string

Allowed values: drift missing unmanaged prune

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 owned by Praxrr and 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

Changed or missing desired entities are alerting; unmanaged entities and pending managed prunes are non-alerting.

string

Allowed values: drift missing unmanaged prune

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

prune

required

Ledger-owned entities pending reviewed removal (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

Changed or missing desired entities are alerting; unmanaged entities and pending managed prunes are non-alerting.

string

Allowed values: drift missing unmanaged prune

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"
        }
      ]
    }
  ],
  "prune": [
    {
      "section": "qualityProfiles",
      "action": "create",
      "category": "drift",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ]
}

400

Instance type is unsupported or the instance is disabled

application/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"
}

404

Instance not found

application/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"
}

409

A drift check for this instance is already in progress

application/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"
}

429

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

application/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"
}

500

Failed to refresh drift

application/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"
}