Skip to content
Praxrr

Generate a sync preview

POST
/sync/preview
curl --request POST \
  --url https://example.com/api/v1/sync/preview \
  --header 'Content-Type: application/json' \
  --data '{ "instanceId": 1, "sections": [ "qualityProfiles" ] }'

Computes a read-only preview of the sync changes for an Arr instance.

This endpoint performs no writes. It only reads from PCD and Arr GET endpoints to compare desired versus current state, then stores a preview snapshot for later retrieval or application.

If no sections are provided, all configured sections for the instance are included.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
instanceId
required

Arr instance ID to preview

integer
sections

Optional section filters for preview generation

Array<string>
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles

Responses

Section titled “Responses”

200

Section titled “200”

Preview generated

Media typeapplication/json
object
id
required

Preview identifier

string
instanceId
required

Target Arr instance ID

integer
instanceName
required

Target Arr instance name

string
arrType
required

Arr instance family

string
Allowed values: radarr sonarr lidarr
createdAt
required

ISO 8601 timestamp when preview was generated

string format: date-time
expiresAt
required

ISO 8601 timestamp when preview becomes expired

string format: date-time
status
required

Preview lifecycle state:

  • generating: build in progress
  • ready: preview fully materialized and runnable
  • applying: preview is being executed as sync
  • applied: execution succeeded
  • failed: generation or execution failed
  • expired: staleness TTL elapsed
string
Allowed values: generating ready applying applied failed expired
error

Optional error message from generation or apply

string
sections
required

Sections included in preview

Array<string>
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
sectionOutcomes
required

Per-section preview generation status used to enforce safe apply behavior.

Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
skipped
required

True when the section had no config to preview and was skipped.

boolean
error
required
One of:
string
qualityProfiles
required
One of:
object
section
required
string
Allowed values: qualityProfiles
customFormats
required

Custom-format change set

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
desired
required
Any of:
string
qualityProfiles
required

Quality-profile change set

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
desired
required
Any of:
string
delayProfiles
required
One of:
object
section
required
string
Allowed values: delayProfiles
profile
required
One of:
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
desired
required
Any of:
string
mediaManagement
required
One of:
object
section
required
string
Allowed values: mediaManagement
naming
required
One of:
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
desired
required
Any of:
string
qualityDefinitions
required

Quality definition change set

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
desired
required
Any of:
string
mediaSettings
required
One of:
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
desired
required
Any of:
string
metadataProfiles
required
One of:
object
section
required
string
Allowed values: metadataProfiles
profile
required
One of:
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
desired
required
Any of:
string
summary
required
object
totalCreates
required

Number of create actions

integer
totalUpdates
required

Number of update actions

integer
totalDeletes
required

Number of delete actions

integer
totalUnchanged
required

Number of unchanged entities

integer
Example
{
  "arrType": "radarr",
  "status": "generating",
  "sections": [
    "qualityProfiles"
  ],
  "sectionOutcomes": [
    {
      "section": "qualityProfiles"
    }
  ],
  "qualityProfiles": {
    "section": "qualityProfiles",
    "customFormats": [
      {
        "action": "create",
        "fields": [
          {
            "type": "added"
          }
        ]
      }
    ],
    "qualityProfiles": [
      {
        "action": "create",
        "fields": [
          {
            "type": "added"
          }
        ]
      }
    ]
  },
  "delayProfiles": {
    "section": "delayProfiles",
    "profile": {
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  },
  "mediaManagement": {
    "section": "mediaManagement",
    "naming": {
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    },
    "qualityDefinitions": [
      {
        "action": "create",
        "fields": [
          {
            "type": "added"
          }
        ]
      }
    ],
    "mediaSettings": {
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  },
  "metadataProfiles": {
    "section": "metadataProfiles",
    "profile": {
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  }
}

400

Section titled “400”

Invalid instanceId, unsupported section, or request body

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Instance not found

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

409

Section titled “409”

Preview for this instance is already generating

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

429

Section titled “429”

Preview creation is rate-limited or preview-store capacity is exhausted

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to generate preview

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}