Diff resolved config entity against live Arr state

GET

/pcd/{databaseId}/resolved/{entityType}/{name}/diff

curl --request GET \
  --url 'https://example.com/api/v1/pcd/1/resolved/delayProfile/example/diff?instanceId=1'

• API v1

Computes the desired-vs-actual field diff for a single named entity on one Arr instance, via the sync-preview section syncer filtered to the entity (namespace-suffix aware). An empty changes array means the entity is in sync; it is never conflatable with a failed check.

Parameters

Path Parameters

databaseId

required

integer

PCD database ID

entityType

required

string

Allowed values: delayProfile regularExpression customFormat qualityProfile naming mediaSettings qualityDefinitions lidarrMetadataProfile

Resolved config entity type

name

required

string

Entity name

Query Parameters

instanceId

required

integer

Arr instance ID to diff resolved state against

Responses

200

Live diff result

Media typeapplication/json

object

databaseId

required

PCD database ID

integer

entityType

required

Resolved config entity type

string

Allowed values: delayProfile regularExpression customFormat qualityProfile naming mediaSettings qualityDefinitions lidarrMetadataProfile

name

required

Entity name

string

instanceId

required

Arr instance ID the live diff was computed against

integer

arrType

required

Arr instance family

string

Allowed values: radarr sonarr lidarr

changes

required

Desired-vs-actual field changes; an empty array means the entity is in sync

Array<object>

object

entityType

required

Sync target entity kind (e.g., customFormat, qualityProfile)

string

name

required

Entity display name (namespace-stripped where applicable)

string

action

required

string

Allowed values: create update delete unchanged

remoteId

required

Arr entity ID when present

integer

nullable

fields

required

Field-level diff; empty for unchanged/create where no deltas are tracked

Array<object>

object

field

required

Dot-notated field path

string

type

required

string

Allowed values: added changed removed

current

required

Any of:

string

string

number

number

integer

integer

boolean

boolean

array

array

object

object

key

additional properties

any

unknown

desired

required

Any of:

string

string

number

number

integer

integer

boolean

boolean

array

array

object

object

key

additional properties

any

unknown

Example

{
  "entityType": "delayProfile",
  "arrType": "radarr",
  "changes": [
    {
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ]
}

400

Invalid databaseId/entityType, entity type unsupported for the instance’s arr_type, or database not ready

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Database not found, Arr instance not found, or entity not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

429

Live diff requests are being rate-limited

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to compute live diff

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}