Skip to content
Praxrr

List recent canary rollouts

GET
/canary/rollouts
curl --request GET \
  --url 'https://example.com/api/v1/canary/rollouts?page=1&pageSize=100'

Returns a paginated list of recent rollouts (newest first) for the history table.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
pageSize
integer
default: 100 >= 1 <= 250

Responses

Section titled “Responses”

200

Section titled “200”

Canary rollout page

Media typeapplication/json
object
items
required
Array<object>
object
id
required
integer
arrType
required

Arr family a rollout is scoped to. A rollout never spans types.

string
Allowed values: radarr sonarr lidarr
status
required

Live state machine of a staged rollout:

  • canary_running: canary sync is executing inline
  • awaiting_confirmation: canary passed, waiting at the verification gate
  • rolling_out: batched rollout job is syncing remaining instances
  • completed: all remaining instances synced cleanly
  • aborted: gate declined, or canary failed/partial-abort/skipped (remaining untouched)
  • failed: rollout ran but one or more remaining instances failed
string
Allowed values: canary_running awaiting_confirmation rolling_out completed aborted failed
canaryInstanceId
required
One of:
integer
canaryInstanceName
required
string
canaryStatus
required
One of:

Classified terminal status of the canary sync run.

string
Allowed values: success partial failed skipped
maxBatchSize
required
integer
>= 1
partialPolicy
required

How a partial canary outcome is treated:

  • gate: pass-with-warning; continue to the verification gate
  • abort: treat as failure; remaining instances are never touched
string
Allowed values: gate abort
trigger
required

How the rollout was initiated.

string
Allowed values: manual system schedule
remainingCount
required

Number of remaining targets, derived from remainingTargets length.

integer
completedCount
required

Number of instances rolled out, derived from rolloutResults length.

integer
startedAt
required
string format: date-time
finishedAt
required
One of:
string format: date-time
createdAt
required
string
updatedAt
required
string
page
required
integer
>= 1
pageSize
required
integer
>= 1
totalRecords
required
integer
totalPages
required
integer
hasNext
required
boolean
Example
{
  "items": [
    {
      "arrType": "radarr",
      "status": "canary_running",
      "canaryStatus": "success",
      "partialPolicy": "gate",
      "trigger": "manual"
    }
  ]
}

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 canary rollouts

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}