Skip to content
Praxrr

Export a portable entity

GET
/pcd/export
curl --request GET \
  --url 'https://example.com/api/v1/pcd/export?databaseId=1&entityType=delay_profile&name=example&includeDependencies=false&format=json'

Serializes a PCD entity into its portable JSON representation.

The portable format strips database IDs and timestamps, producing a self-contained snapshot suitable for clipboard copy, file export, or cross-database import.

name may be repeated (?name=A&name=B) to export several entities of the same entityType. Set includeDependencies=true to also export the custom formats and regular expressions a quality profile references (and the regular expressions a custom format references). Set format=bundle to force the bundle response shape.

Response shape rule: the legacy ExportResponse (entityType, data, migration) is returned if and only if exactly one name is supplied and neither includeDependencies=true nor format=bundle is set. Every other request returns a PcdBundleExportResponse. A bundle holds at most 1000 entities; exceeding the cap returns 400.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
databaseId
required
integer

The PCD database ID to export from

entityType
required

Portable PCD entity identifiers used by import/export endpoints.

Lidarr media-management entities are first-class portable contract members:

  • lidarr_naming
  • lidarr_media_settings
  • lidarr_quality_definitions

Runtime validation is deterministic and fail-fast for Lidarr payloads: payloads are rejected when required fields are missing, when unsupported fields are present, or when cross-family fields are mixed into the payload (for example Radarr naming fields with lidarr_naming).

Clients must emit lidarr_* entity types for Lidarr entities.

string
Allowed values: delay_profile regular_expression custom_format quality_profile radarr_naming sonarr_naming radarr_media_settings sonarr_media_settings radarr_quality_definitions sonarr_quality_definitions lidarr_metadata_profile lidarr_naming lidarr_media_settings lidarr_quality_definitions

The entity type to export

name
required
Array<string>
>= 1 items

The entity name to export. Repeat the parameter to export several entities.

includeDependencies
boolean

Also export referenced custom formats and regular expressions.

format
string
default: json
Allowed values: json bundle

Force the response shape. bundle always returns a PcdBundleExportResponse.

Responses

Section titled “Responses”

200

Section titled “200”

Portable entity JSON (legacy shape) or entity bundle

Media typeapplication/json
One of:
object
entityType
required

Portable PCD entity identifiers used by import/export endpoints.

Lidarr media-management entities are first-class portable contract members:

  • lidarr_naming
  • lidarr_media_settings
  • lidarr_quality_definitions

Runtime validation is deterministic and fail-fast for Lidarr payloads: payloads are rejected when required fields are missing, when unsupported fields are present, or when cross-family fields are mixed into the payload (for example Radarr naming fields with lidarr_naming).

Clients must emit lidarr_* entity types for Lidarr entities.

string
Allowed values: delay_profile regular_expression custom_format quality_profile radarr_naming sonarr_naming radarr_media_settings sonarr_media_settings radarr_quality_definitions sonarr_quality_definitions lidarr_metadata_profile lidarr_naming lidarr_media_settings lidarr_quality_definitions
migration

Optional migration metadata for hybrid ingestion/egress.

object
format
required

Migration payload format marker (json for JSON payloads, yaml for YAML in future hybrid ingestion flows).

string
Allowed values: json yaml
version
required

Migration schema contract version for hybrid payloads.

integer
>= 1
source
required

Migration source marker (example: pcd-export, pcd-file, pcd-importer).

string
data
required
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
Example
{
  "entityType": "delay_profile",
  "migration": {
    "format": "json"
  },
  "data": {
    "preferredProtocol": "prefer_usenet"
  }
}

400

Section titled “400”

Missing or invalid parameters, the bundle exceeds the 1000 entity cap, or the dependency walk was truncated

Media typeapplication/json
object
error
required
string
code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string
Examplegenerated
{
  "error": "example",
  "code": "example"
}

404

Section titled “404”

Entity not found

Media typeapplication/json
object
error
required
string
code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string
Examplegenerated
{
  "error": "example",
  "code": "example"
}

500

Section titled “500”

Database cache not available

Media typeapplication/json
object
error
required
string
code

Optional machine-readable error code, for example sync_in_progress or preview_stale

string
Examplegenerated
{
  "error": "example",
  "code": "example"
}