Skip to content
Praxrr

Sync history entry detail

GET
/sync-history/{id}
curl --request GET \
  --url https://example.com/api/v1/sync-history/1

Returns one sync run audit entry with the full section results and diff.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

Responses

Section titled “Responses”

200

Section titled “200”

Sync history detail

Media typeapplication/json
object
id
required
integer
arrInstanceId
required
One of:
integer
instanceName
required
string
arrType
required
string
Allowed values: radarr sonarr lidarr
jobId
required
One of:
integer
trigger
required

How a sync run was initiated.

string
Allowed values: manual schedule system
triggerEvent
required
One of:
string
sectionsAttempted
required
Array<string>
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
status
required

Terminal status of an audited sync run.

string
Allowed values: success partial failed skipped
sectionsRun
required
integer
itemsSynced
required
integer
failureCount
required
integer
entityChangeCount
required
integer
entityOutcomeCount
required

Number of confirmed per-entity outcomes captured from the actual Arr writes (issue

integer
previewId
required
One of:
string
error
required
One of:
string
startedAt
required
string format: date-time
finishedAt
required
One of:
string format: date-time
durationMs
required
One of:
integer
createdAt
required
string
sectionResults
required
Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
status
required
string
Allowed values: success failed skipped
itemsSynced
required
integer
error
required
One of:
string
failedProfiles
Array<string>
changes
required
Array<object>
object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
category
required

Sibling collection within the section (e.g. customFormats, naming).

string
entityType
required
string
name
required

Entity display name (namespace-stripped).

string
action
required
string
Allowed values: create update delete unchanged
remoteId
required
integer
nullable
fields
required

Field-level diff (current = live/old, desired = PCD/new).

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

Confirmed per-entity outcomes captured from the actual Arr writes (issue

Array<object>

A confirmed, per-entity terminal outcome captured from an actual Arr write (issue #232). Exactly one is produced per attempted entity. Unlike the preview EntityChange (planned intent), status proves what the Arr instance actually did.

object
section
required

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
arrType
required

Arr type of the target instance — set explicitly by the syncer, never inferred.

string
Allowed values: radarr sonarr lidarr
entityType
required

The kind of entity a confirmed outcome describes.

string
Allowed values: customFormat qualityProfile delayProfile metadataProfile naming mediaSettings qualityDefinitions
name
required

Stable identity — the unsuffixed PCD name (or subsection label for singletons).

string
action
required

The write attempted for an entity (intent). delete is reserved; no syncer emits it yet.

string
Allowed values: create update delete
status
required

Terminal status of a per-entity Arr write, sourced ONLY from the write result: success (resolved), failed (threw), skipped (intentionally not written).

string
Allowed values: success skipped failed
remoteId
required
One of:
string
reason
required
One of:
string
Example
{
  "arrType": "radarr",
  "trigger": "manual",
  "sectionsAttempted": [
    "qualityProfiles"
  ],
  "status": "success",
  "sectionResults": [
    {
      "section": "qualityProfiles",
      "status": "success"
    }
  ],
  "changes": [
    {
      "section": "qualityProfiles",
      "action": "create",
      "fields": [
        {
          "type": "added"
        }
      ]
    }
  ],
  "entityOutcomes": [
    {
      "section": "qualityProfiles",
      "arrType": "radarr",
      "entityType": "customFormat",
      "action": "create",
      "status": "success"
    }
  ]
}

400

Section titled “400”

Invalid id

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Entry not found

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to read sync history entry

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}