Sign in

v2

latestOpenAPI 3.0.1Apache 2.02026-07-2698173135.4 KB
Platform

Get Placements

Simulates placing the specified number of machines into regions, depending on available capacity and limits.

post/platform/placements

Request body

countinteger

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

org_slugstring required
regionstring

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.

volume_namestring
volume_size_bytesinteger
weightsPlacementWeights

Example request

{
  "org_slug": "personal",
  "region": "lhr,eu"
}

Response

OK