Skip to content
Praxrr
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Documentation version
v2.0 (Latest)
Next (dev)
Start Here
Overview
Feature Tour
Getting Started
Overview
Installation
Quick Start
Docker
Guides
Configuration
Connecting Arr Instances
Syncing Profiles
Custom Formats
Quality Profiles
MCP Server
Metrics
Upgrading
Troubleshooting
Application
Architecture
Startup Sequence
Development Setup
PCD System
Job System
Sync Pipeline
Notifications
Testing
Docs Versioning
Screenshots
Component Library
Overview
Buttons & Actions
Form Inputs
Tables & Lists
Modals & Dialogs
Dropdowns & Tabs
Navigation Shell
Badges & Labels
Cards
Feedback & States
Display & Formatting
Complexity Tiers
Store Patterns
Plugin SDK
Overview
Build & Install the Example
Manifest Reference
Capabilities & Least Privilege
Extension Points
Observe Snapshots
Lifecycle & Registry
API Versioning & Stability
PCD Schema
Overview
Structure
Manifest
Condition Types
Migration Paths
Tables
Index
Core Entities
tags
languages
regular_expressions
qualities
quality_api_mappings
custom_formats
Profiles & Junctions
quality_profiles
quality_groups
custom_format_conditions
regular_expression_tags
custom_format_tags
quality_profile_tags
quality_profile_languages
quality_group_members
quality_profile_qualities
quality_profile_custom_formats
Condition Types
condition_patterns
condition_languages
condition_indexer_flags
condition_sources
condition_resolutions
condition_quality_modifiers
condition_sizes
condition_release_types
condition_years
Media Management
radarr_quality_definitions
sonarr_quality_definitions
lidarr_quality_definitions
radarr_naming
sonarr_naming
lidarr_naming
radarr_media_settings
sonarr_media_settings
lidarr_media_settings
Metadata, Delay & Testing
lidarr_metadata_profiles
lidarr_metadata_profile_primary_types
lidarr_metadata_profile_secondary_types
lidarr_metadata_profile_release_statuses
delay_profiles
custom_format_tests
test_entities
test_releases
PCD Database
Overview
Mirror README
Custom Formats
Catalog Overview
Resolution & Source
Audio
Codecs & HDR
Release Groups
Streaming Services
Editions & Flags
Language & Anime
Unwanted & Banned
Quality Profiles
Overview
Video Presets
Release & Delay Profiles
Lidarr Support
Changelog
API Reference
Overview
System
Overview
Health check
GET
OpenAPI specification
GET
Parser health check
GET
Prometheus metrics
GET
Latest startup pull run
GET
Entity Testing
Overview
Evaluate releases against custom formats
POST
Score Simulator
Overview
Simulate custom format scoring for releases
POST
Impact Simulator
Overview
Simulate configuration change impact for releases
POST
Arr
Overview
Get Arr instance library
GET
Invalidate library cache
DELETE
Get episode details for a Sonarr series
GET
Search for releases
GET
Scan or execute cleanup of stale configs
POST
Generate a sync preview
POST
Get a sync preview
GET
Discard a sync preview
DELETE
Apply a sync preview
POST
Trash Guide
Overview
Get one TRaSH cached entity
GET
Resolve current + latest terminal run for a TRaSH source
GET
Enqueue a manual TRaSH source sync
POST
PCD
Overview
Export a portable entity
GET
Import a portable entity or entity bundle
POST
List Lidarr metadata profiles
GET
Create a Lidarr metadata profile
POST
Get one Lidarr metadata profile
GET
Update a Lidarr metadata profile
PUT
Delete a Lidarr metadata profile
DELETE
PCD Databases
Overview
Preview incoming upstream PCD changes
GET
PCD Snapshots
Overview
List PCD snapshots for a database
GET
Create a manual PCD snapshot
POST
Get PCD snapshot detail
GET
Delete a PCD snapshot
DELETE
Preview restoring a PCD snapshot
GET
Execute a PCD point-in-time restore
POST
Resolved Config
Overview
List resolved config entities by type
GET
Get one resolved config entity by name
GET
Compare one resolved config entity across instances
GET
Diff resolved config entity against live Arr state
GET
Local Overrides
Overview
List local PCD overrides
GET
Undo the latest local PCD change
POST
Revert an entity's local PCD overrides
POST
Dependency Graph
Overview
Get the resolved dependency graph for a PCD database
GET
Get the dependency impact of a single entity
GET
User Preferences
Overview
Read one UI preference
GET
Upsert one UI preference
PATCH
Complexity Tiers
Overview
Read one complexity tier
GET
Upsert one complexity tier
PATCH
Setup
Overview
Get setup wizard state
GET
Advance the wizard step
PATCH
Test an Arr connection during setup
POST
Mark setup wizard completed
POST
Mark setup wizard dismissed
POST
Reopen the setup wizard
POST
Permanently dismiss the setup checklist
POST
Compatibility
Overview
Cross-Arr compatibility parity map
GET
Feature-by-version compatibility matrix
GET
Drift Detection
Overview
Drift detection summary
GET
Per-instance drift detail
GET
Refresh drift for one instance on demand
POST
Update drift detection settings
PUT
Sync History
Overview
List / search sync history
GET
Sync history entry detail
GET
Export sync history
GET
Get sync history settings
GET
Update sync history settings
PATCH
Quality Goals
Overview
List Quality Goal presets and slider axes
GET
Preview the config a goal would generate (non-persisting)
POST
Apply a goal to a quality profile
POST
Get the latest apply outcome for a quality profile
GET
Recover a partial or pending Quality Goals apply
POST
Get the goal binding for a quality profile
GET
Canary
Overview
List recent canary rollouts
GET
Start a canary rollout
POST
Canary rollout detail
GET
Proceed past the verification gate
POST
Abort the rollout at the verification gate
POST
Get canary settings
GET
Update canary settings
PATCH
Events
Overview
Live event stream (SSE)
GET
Probe the live event stream
HEAD
Config Health
Overview
Fleet config-health summary
GET
Config-health detail for one instance
GET
Recompute config-health for one instance on demand
POST
Read config-health history for one instance
GET
Export config-health history for one instance
GET
Read config-health settings
GET
Update config-health settings
PUT
Security Posture
Overview
Security posture shield report
GET
Timeline
Overview
List / search the sync-archaeology timeline
GET
Export the timeline
GET
List annotations for one event
GET
Attach a note to a timeline event
POST
Delete an annotation
DELETE
Edit an annotation
PATCH
MCP
Overview
Method not allowed
GET
MCP Streamable HTTP endpoint
POST
Method not allowed
DELETE
Plugins
Overview
List durable plugin registry state
GET
Get plugin ecosystem enablement
GET
Update plugin ecosystem enablement
PATCH
Rescan and atomically reconcile plugins
POST
Read one API-version-qualified plugin
GET
Enable one durable plugin identity
POST
Disable one durable plugin identity
POST
WebAuthn
Overview
Begin passkey registration
POST
Complete passkey registration
POST
Begin passkey login
POST
Complete passkey login
POST
Webhooks
Notification event delivered to a generic webhook service
POST
GitHub
Select theme
Dark
Light
Auto
Overview
Events
Section titled “Events”
Live job, sync, canary and drift progress over Server-Sent Events
Operations
Section titled “Operations”
GET
/events
HEAD
/events