Skip to main content
POST
Get Placements

Authorizations

Authorization
string
header
required

A Fly API token with access to the requested organization or resource. Send it as Authorization: Bearer <Fly API token>.

Body

application/json

Get placements request

org_slug
string
required

Slug of the organization to place Machines for, or personal. Required.

Example:

"personal"

compute
object

Resource requirements for the Machine to simulate. Defaults to a performance-1x machine

count
integer

Number of machines to simulate placement. Defaults to 0, which returns the org-specific limit for each region.

region
string

Region expression for placement as a comma-delimited set of regions or aliases. Defaults to the API endpoint's local region. When count is greater than 0, any is added as a fallback.

Example:

"lhr,eu"

volume_name
string

Currently unused.

Example:

""

volume_size_bytes
integer

Size of a volume each Machine will need, in bytes. Only hosts with room for it are considered.

weights
object

Optional weights to override default placement preferences.

Example:

Response

200 - application/json

OK

Regions
object[]

The regions Machines would be placed in. With count 0, every requested region with the organization's Machine limit in it.