Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
type
enum<string>
default:prepare
Available options:
prepare,
switch,
full
mode
enum<string>
default:dry_run
Available options:
dry_run,
repair,
switch_space,
switch_global
spaceIds
string[]
baseIds
string[]
excludeSpaceIds
string[]
excludeBaseIds
string[]
sourceJobId
string
concurrency
integer
default:1
Required range: 1 <= x <= 8
autoStart
boolean
default:true
allowBlockedSwitch
boolean
default:false
forceNew
boolean
default:false

Response

200 - application/json

Created v2 rollout job

id
string
required
type
enum<string>
required
Available options:
prepare,
switch,
full
status
enum<string>
required
Available options:
pending,
running,
paused,
completed,
completed_with_blocks,
failed,
canceled
mode
enum<string>
required
Available options:
dry_run,
repair,
switch_space,
switch_global
totalSpaces
number
required
totalBases
number
required
readySpaces
number
required
readyBases
number
required
blockedSpaces
number
required
blockedBases
number
required
failedSpaces
number
required
failedBases
number
required
skippedSpaces
number
required
skippedBases
number
required
switchedSpaces
number
required
createdTime
string
required
lastEventSeq
number
required
phase
enum<string> | null
Available options:
inventory,
checking,
repairing,
verifying,
switching
options
unknown
error
string | null
createdBy
string | null
startedTime
string | null
finishedTime
string | null
Last modified on September 15, 2026