> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Placements

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



## OpenAPI

````yaml /machines-api/openapi.json post /v1/platform/placements
openapi: 3.0.1
info:
  title: Machines API
  description: >-
    This site hosts documentation generated from the Fly.io Machines API OpenAPI
    specification. Visit our complete [Machines API
    docs](https://fly.io/docs/machines/api/) for how to get started, more
    information about each endpoint, parameter descriptions, and examples.
  contact: {}
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: https://api.machines.dev
security: []
tags:
  - name: Apps
    description: >-
      This site hosts documentation generated from the Fly.io Machines API
      OpenAPI specification. Visit our complete [Machines API
      docs](https://fly.io/docs/machines/api/apps-resource/) for details about
      using the Apps resource.
  - name: Machines
    description: >-
      This site hosts documentation generated from the Fly.io Machines API
      OpenAPI specification. Visit our complete [Machines API
      docs](https://fly.io/docs/machines/api/machines-resource/) for details
      about using the Machines resource.
  - name: TLS Certificates
    description: >
      This site hosts documentation generated from the Fly.io Machines API
      OpenAPI specification. Visit our complete [Machines API
      docs](https://fly.io/docs/machines/api/certificates-resource/) for details
      about using the TLS Certificates resource.
  - name: Volumes
    description: >-
      This site hosts documentation generated from the Fly.io Machines API
      OpenAPI specification. Visit our complete [Machines API
      docs](https://fly.io/docs/machines/api/volumes-resource/) for details
      about using the Volumes resource.
  - name: Postgres Clusters
    description: >-
      Create and manage Postgres clusters, including databases, users,
      extensions, backups, and app attachments.
externalDocs:
  url: https://fly.io/docs/machines/working-with-machines/
paths:
  /v1/platform/placements:
    post:
      tags:
        - Platform
      summary: Get Placements
      description: >-
        Simulates placing the specified number of machines into regions,
        depending on available capacity and limits.
      operationId: Platform_placements_post
      requestBody:
        description: Get placements request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/main.getPlacementsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.getPlacementsResponse'
components:
  schemas:
    main.getPlacementsRequest:
      required:
        - org_slug
      type: object
      properties:
        compute:
          type: object
          description: >-
            Resource requirements for the Machine to simulate. Defaults to a
            performance-1x machine
          allOf:
            - $ref: '#/components/schemas/fly.MachineGuest'
        count:
          type: integer
          description: |-
            Number of machines to simulate placement.
            Defaults to 0, which returns the org-specific limit for each region.
        org_slug:
          type: string
          example: personal
        region:
          type: string
          description: >-
            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:
          type: string
          example: ''
        volume_size_bytes:
          type: integer
        weights:
          type: object
          description: Optional weights to override default placement preferences.
          example:
            region: 1000
            spread: 0
          allOf:
            - $ref: '#/components/schemas/placement.Weights'
    main.getPlacementsResponse:
      type: object
      properties:
        regions:
          type: array
          items:
            $ref: '#/components/schemas/placement.RegionPlacement'
    fly.MachineGuest:
      type: object
      properties:
        cpu_kind:
          type: string
        cpus:
          type: integer
        gpu_kind:
          type: string
        gpus:
          type: integer
        host_dedication_id:
          type: string
        kernel_args:
          type: array
          items:
            type: string
        max_memory_mb:
          type: integer
        memory_mb:
          type: integer
        persist_rootfs:
          type: string
          description: 'Deprecated: use MachineConfig.Rootfs instead'
          enum:
            - never
            - always
            - restart
        required_host_features:
          type: array
          items:
            type: string
    placement.Weights:
      type: object
      additionalProperties:
        type: integer
    placement.RegionPlacement:
      type: object
      properties:
        concurrency:
          type: integer
        count:
          type: integer
        region:
          type: string

````