List local PCD overrides

GET

/pcd/{databaseId}/overrides

const url = 'https://example.com/api/v1/pcd/1/overrides?entityType=delayProfile&arrType=radarr';
const options = {method: 'GET'};

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

curl --request GET \
  --url 'https://example.com/api/v1/pcd/1/overrides?entityType=delayProfile&arrType=radarr'

Lists entities with published user ops and their upstream-base-to-resolved field differences. Net-zero edits remain listed until their user ops are reverted. Builds the base-only cache once per request. lastAction always describes the latest action across the whole database, independent of filters. API tokens require read scope.

Parameters

Path Parameters

databaseId

required

integer

>= 1

PCD database ID

Query Parameters

entityType

string

Allowed values: delayProfile regularExpression customFormat qualityProfile naming mediaSettings qualityDefinitions lidarrMetadataProfile

Optional resolved entity family filter

arrType

string

Allowed values: radarr sonarr lidarr

Explicit Arr app filter. Required when entityType is naming, mediaSettings, or qualityDefinitions. Required and must be lidarr for lidarrMetadataProfile. Rejected when entityType is delayProfile, regularExpression, customFormat, or qualityProfile. Never inferred from a sibling Arr app.

Responses

200

Local override entities and the latest undoable action

application/json

object

databaseId

required

integer

entities

required

Array

object

entityType

required

Resolved config entity type

string

Allowed values: delayProfile regularExpression customFormat qualityProfile naming mediaSettings qualityDefinitions lidarrMetadataProfile

arrType

required

Explicit Arr app for scoped entities; null for Arr-agnostic entities

string

nullable

Allowed values: radarr sonarr lidarr

name

required

Current resolved entity name, preserved exactly without trimming

string

>= 1 characters

kind

required

string

Allowed values: modified created deleted

present

required

Whether the entity exists in the resolved state

boolean

existsInBase

required

Whether the entity exists in the upstream base state

boolean

overrides

required

Field-level differences from upstream base to resolved state. An empty array can coexist with published user ops (a net-zero edit remains locally modified).

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

hasPendingConflict

required

boolean

ops

required

Array<object>

A published user operation attributed to an entity

object

required

integer

operation

required

string

title

required

string

summary

required

string

nullable

changedFields

required

Array<string>

actionId

required

User-action undo unit; null for legacy ops without action_id metadata

string

nullable

groupId

required

Explicit dependent-operation group, when present

string

nullable

status

required

Latest operation-history status; null when no history exists

string

nullable

createdAt

required

string format: date-time

lastAction

required

object

actionId

required

Undo-unit identifier; echo as expectedActionId to guard against stale undo

string

key

required

Namespaced undo key (action:, group:, or op:)

string

opIds

required

Array<integer>

entities

required

Array<object>

object

entityType

required

Resolved config entity type

string

Allowed values: delayProfile regularExpression customFormat qualityProfile naming mediaSettings qualityDefinitions lidarrMetadataProfile

arrType

required

Explicit Arr app for scoped entities; null for Arr-agnostic entities

string

nullable

Allowed values: radarr sonarr lidarr

name

required

Current resolved entity name, preserved exactly without trimming

string

>= 1 characters

createdAt

required

string format: date-time

unmappedOpCount

required

Published user ops whose entity identity cannot be resolved safely

integer

Example

{
  "entities": [
    {
      "entityType": "delayProfile",
      "arrType": "radarr",
      "kind": "modified",
      "overrides": [
        {
          "type": "added"
        }
      ]
    }
  ],
  "lastAction": {
    "entities": [
      {
        "entityType": "delayProfile",
        "arrType": "radarr"
      }
    ]
  }
}

400

Invalid filters or databaseId, unavailable database, or unbuilt cache

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

401

Authentication required

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

403

The API token lacks the read scope.

application/json

An authenticated API token lacks the scope the requested route requires.

object

error

required

Always Forbidden.

string

requiredScope

required

The API token scope this request requires.

string

Allowed values: read mcp sync:apply admin

Example

{
  "requiredScope": "read"
}

500

Failed to list local overrides

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