Skip to content
Praxrr

Get one resolved config entity by name

GET
/pcd/{databaseId}/resolved/{entityType}/{name}
curl --request GET \
  --url 'https://example.com/api/v1/pcd/1/resolved/delayProfile/example?layer=base&arrType=radarr&includeLineage=false'

Returns resolved config state for a single named entity, for the selected layer.

layer defaults to resolved. 404 is reserved for a hard miss in the resolved layer; the base/user layers return 200 with present: false when the entity does not exist in that layer.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “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

Section titled “Query Parameters”
layer
string
default: resolved
Allowed values: base user resolved

Resolved config layer to read

arrType
string
Allowed values: radarr sonarr lidarr

Arr app type. Required for per-arr-app entity types (naming, mediaSettings, qualityDefinitions); rejected for arr-agnostic entity types and for lidarrMetadataProfile.

includeLineage
boolean

When true and layer=resolved, attaches exact per-field lineage (lineage + lineageStatus) identifying the source layer and establishing op for each resolved value. Ignored for layer=base/layer=user. Defaults to false.

Responses

Section titled “Responses”

200

Section titled “200”

Resolved entity state

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
layer
required

PCD configuration layer represented by a resolved-state response:

  • base: schema + base + tweaks ops only (user ops omitted)
  • user: user-op overrides relative to the base layer, expressed as a field-level diff
  • resolved: the fully replayed state (schema -> base -> tweaks -> user), matching what sync applies to Arr instances
string
Allowed values: base user resolved
present
required

Whether the entity exists in the requested layer

boolean
entity
One of:
object
name
required
string
preferredProtocol
required
string
Allowed values: prefer_usenet prefer_torrent only_usenet only_torrent
usenetDelay
required
integer
torrentDelay
required
integer
bypassIfHighestQuality
required
boolean
bypassIfAboveCfScore
required
boolean
minimumCfScore
required
integer
overrides

Field-level diff of user-op overrides relative to the base layer. Present only for layer=user; an empty array means the resolved value matches base exactly.

Array<object>
nullable
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

True when a pending value-guard conflict targets this entity (see pcd_op_history). The resolved value must not be treated as unambiguous while this is true.

boolean
lineage

Exact per-field lineage. Present only when includeLineage=true and layer=resolved; null/absent otherwise.

Array<object>
nullable

Exact provenance for one resolved nested field. status is the gate: resolved rows name a source; ambiguous/unavailable rows make no source claim. schema-default means no op explicitly wrote the column and its value equals the parsed schema DEFAULT; it is never inferred from the mere absence of a user override.

object
fieldPath
required

Nested field path, byte-identical to the diff convention used by overrides (e.g. conditions["HDR"].negate, orderedItems["WEB"].members[0].name).

string
status
required

resolved: a source is named. ambiguous: evidence conflicts, is pending, or the op SQL was unparseable. unavailable: no establishing op and no default backs this path.

string
Allowed values: resolved ambiguous unavailable
sourceLayer

The establishing layer; null unless status is resolved.

string
nullable
Allowed values: schema base tweaks user
sourceKind
required

Source classification, aligned with sourceLayer for resolved rows.

string
Allowed values: schema-default base-op tweaks-op user-op ambiguous unavailable
opId

Establishing pcd_ops id for base/user (DB) ops; null for file layers (schema/tweaks) and schema-default.

integer
nullable
opRef

File-layer op identity (schema/tweaks), which has no pcd_ops row; null for DB ops.

object
filename
required
string
order
required
integer
explicit
required

True when an op explicitly named this column (distinct from an implicit default).

boolean
valueEqualsDefault

Display-only signal indicating the resolved value equals the schema default. Never used to classify provenance. Absent when not comparable.

boolean
lineageStatus

Entity-level lineage rollup. ambiguous when a pending value-guard conflict withholds all field claims; unavailable when the entity is absent. Present only alongside lineage.

string
nullable
Allowed values: available ambiguous unavailable
Example
{
  "entityType": "delayProfile",
  "layer": "base",
  "entity": {
    "preferredProtocol": "prefer_usenet"
  },
  "overrides": [
    {
      "type": "added"
    }
  ],
  "lineage": [
    {
      "status": "resolved",
      "sourceLayer": "schema",
      "sourceKind": "schema-default"
    }
  ],
  "lineageStatus": "available"
}

400

Section titled “400”

Invalid databaseId, unknown entityType, missing/invalid arrType, or database not ready

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

401

Section titled “401”

Authentication required

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Database not found, or entity not found in the resolved layer

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to read resolved config state

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}