Skip to main content
POST
Deploy Rebalance
When called with an API key, the key needs the models scope (about scopes).

Authorizations

Authorization
string
header
required

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

Headers

xi-api-key
string | null
x-api-key
string | null

Path Parameters

deploy_id
string
required

Body

application/json
target_deploy_id
string
required

Deployment to grow using GPUs freed from this one.

count
integer
required

Number of target instances to create.

Required range: 1 <= x <= 2147483647
concurrency
integer
default:1

How many target instances may start at once (default 1). Higher finishes sooner at a deeper dip in source capacity; clamped to count. How many source instances that takes down depends on their relative size: one target instance the size of 4 source instances stops 4 of them at once, while a source instance that yields 4 target instances is always drained in one go, starting all 4.

Required range: 1 <= x <= 5
dry_run
boolean
default:false

Validate and preview without moving anything.

Response

Successful Response

gpu
string
required

GPU type being rebalanced.

source_instances
integer
required

Source instances now.

source_instances_after
integer
required

Source instances once the rebalance completes.

target_instances
integer
required

Target instances now.

target_instances_after
integer
required

Target instances once the rebalance completes.

replace_id
string
default:""

Id of the started rebalance; empty on a dry run.