Skip to main content
PATCH
Update fleet

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Body

application/json
pool_id
string | null

The pool its machines join. Machines already running move with it

order
integer
Required range: x >= 0
mode
enum<string>

manual: someone sets the number of machines. demand: they start when work waits and go when idle

Available options:
manual,
demand
min
integer
Required range: 0 <= x <= 1000
max
integer
Required range: 0 <= x <= 1000
idle_minutes
integer
Required range: 1 <= x <= 1440

Response

The updated fleet

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

connection_id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

resource_id
string
required
name
string
required
region
string
required
size
string
required
spot
boolean
required
os
enum<string> | null
required
Available options:
linux,
windows,
null
capacity
integer
required

Machines the scale set runs, as last read

joined
integer
default:0
required

Machines whose node is up; the rest of capacity is still starting

pool_id
string | null
required
order
integer
required

Lower is asked first among a pool's fleets

mode
enum<string>
required

manual: someone sets the number of machines. demand: they start when work waits and go when idle

Available options:
manual,
demand
min
integer
required
max
integer
required
idle_minutes
integer
required
profile
object | null
required

What the test machine reported. The fleet only scales up for work these apps can render

error
string | null
required
failure
object | null
required

Why machines did not become nodes. Cleared when one does

held_until
integer | null
required

Until then it adds no machine by itself: after a cancel, or after its machines never joined

Example:

1785846207000

checked_at
integer | null
required
Example:

1785846207000

created_at
integer
required
Example:

1785846207000

updated_at
integer
required
Example:

1785846207000