List / search sync history

GET

/sync-history

const url = 'https://example.com/api/v1/sync-history?arrType=radarr&status=success&trigger=manual&section=qualityProfiles&page=1&pageSize=100';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

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.

string format: date-time

ISO-8601 upper bound on startedAt.

string

Free-text match on instance name or error.

page

integer

default: 1 >= 1

pageSize

integer

default: 100 >= 1 <= 250

Responses

200

Sync history page

application/json

object

items

required

Array<object>

object

required

integer

arrInstanceId

required

One of:

integer
null

integer

instanceName

required

string

arrType

required

string

Allowed values: radarr sonarr lidarr

jobId

required

One of:

integer
null

integer

trigger

required

How a sync run was initiated.

string

Allowed values: manual schedule system

triggerEvent

required

One of:

string
null

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
null

string

error

required

One of:

string
null

string

startedAt

required

string format: date-time

finishedAt

required

One of:

string
null

string format: date-time

durationMs

required

One of:

integer
null

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

Invalid query parameter

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}

500

Failed to list sync history

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}