Skip to main content
POST
Get Placements

Body

application/json

Get placements request

org_slug
string
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 "[region],any", to prefer the API endpoint's local region with any other region as fallback.

Example:

"lhr,eu"

volume_name
string
Example:

""

volume_size_bytes
integer
weights
object

Optional weights to override default placement preferences.

Example:

Response

200 - application/json

OK

regions
object[]