Platform

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

post/v1/platform/placements

Request

  • Base URL
    https://api.machines.dev
  • URL
    https://api.machines.dev/v1/platform/placements
  • Auth
    HTTP bearer

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

Changes

    • breaking

      the ///// request property format changed from no format to int64

    • info

      added the new optional request property /////