Skip to content
Praxrr

List / search sync history

GET
/sync-history
curl --request GET \
  --url 'https://example.com/api/v1/sync-history?arrType=radarr&status=success&trigger=manual&section=qualityProfiles&page=1&pageSize=100'

Returns a filtered, paginated list of sync run audit entries (newest first). All filters are optional and combine with AND. This endpoint returns 500 only on an internal error; invalid query params return 400.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
instanceId
integer
arrType
string
Allowed values: radarr sonarr lidarr
status

Terminal status of an audited sync run.

string
Allowed values: success partial failed skipped
trigger

How a sync run was initiated.

string
Allowed values: manual schedule system
section

Sync section handled by preview generation

string
Allowed values: qualityProfiles delayProfiles mediaManagement metadataProfiles
from
string format: date-time

ISO-8601 lower bound on startedAt.

to
string format: date-time

ISO-8601 upper bound on startedAt.

q
string

Free-text match on instance name or error.

page
integer
default: 1 >= 1
pageSize
integer
default: 100 >= 1 <= 250

Responses

Section titled “Responses”

200

Section titled “200”

Sync history page

Media typeapplication/json
object
items
required
Array<object>
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
page
required
integer
>= 1
pageSize
required
integer
>= 1
totalRecords
required
integer
totalPages
required
integer
hasNext
required
boolean
Example
{
  "items": [
    {
      "arrType": "radarr",
      "trigger": "manual",
      "sectionsAttempted": [
        "qualityProfiles"
      ],
      "status": "success"
    }
  ]
}

400

Section titled “400”

Invalid query parameter

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to list sync history

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}