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

# List placement servers

> List placement servers.



## OpenAPI

````yaml /openapi/reservation-openapi.yaml get /api/v2/placements/{placementID}/servers
openapi: 3.0.3
info:
  title: Unikorn Reservation API
  description: |-
    Reservation service provides topology-aware bare metal GPU reservation and
    placement, sitting atop UNI Region service resources.
  version: 0.5.0
servers:
  - url: https://reservation.nks.europe-west4.nscale.com
    description: Production
  - url: https://reservation.nks-stg.europe-west2.nscale.com
    description: Staging
  - url: https://reservation.nks-dev.glo1.nscale.com
    description: Development
security: []
paths:
  /api/v2/placements/{placementID}/servers:
    description: |-
      Lists the public server read models for the hosts allocated by a
      Placement. Placement servers expose Reservation-owned identities and
      runtime Region server state without exposing backing infrastructure IDs.
    parameters:
      - $ref: '#/components/parameters/placementIDParameter'
    get:
      tags:
        - Placement Servers
      summary: List placement servers
      description: List placement servers.
      operationId: listPlacementServers
      responses:
        '200':
          $ref: '#/components/responses/placementServersV2Response'
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '401':
          $ref: '#/components/responses/unauthorizedResponse'
        '403':
          $ref: '#/components/responses/forbiddenResponse'
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      security:
        - oauth2Authentication: []
components:
  parameters:
    placementIDParameter:
      name: placementID
      in: path
      description: The placement ID.
      required: true
      schema:
        $ref: '#/components/schemas/kubernetesNameParameter'
  responses:
    placementServersV2Response:
      description: A list of placement servers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/placementServersV2Read'
          example:
            - metadata:
                id: psrv-7f3d9d5d2a7c4e32
                name: training-workers-0
                organizationId: 9a8c6370-4065-4d4a-9da0-7678df40cd9d
                projectId: e36c058a-8eba-4f5b-91f4-f6ffb983795c
                creationTime: '2026-04-28T11:04:00Z'
                createdBy: john.doe@example.com
                provisioningStatus: provisioned
                healthStatus: healthy
              status:
                regionId: c7568e2d-f9ab-453d-9a3a-51375f78426b
                reservationId: a64f9269-36e0-4312-b8d1-52d93d569b7b
                placementId: b8ce034e-fccb-4d6c-a0e0-af3e3f346715
                networkId: 61f0ad85-3001-41cb-824a-e6a047668dfe
                powerState: Running
                privateIP: 10.0.0.12
                publicIP: 203.0.113.12
                macAddress: fa:16:3e:7c:11:8a
            - metadata:
                id: psrv-950ab3259a1443da
                name: training-workers-1
                organizationId: 9a8c6370-4065-4d4a-9da0-7678df40cd9d
                projectId: e36c058a-8eba-4f5b-91f4-f6ffb983795c
                creationTime: '2026-04-28T11:04:02Z'
                createdBy: john.doe@example.com
                provisioningStatus: provisioned
                healthStatus: healthy
              status:
                regionId: c7568e2d-f9ab-453d-9a3a-51375f78426b
                reservationId: a64f9269-36e0-4312-b8d1-52d93d569b7b
                placementId: b8ce034e-fccb-4d6c-a0e0-af3e3f346715
                networkId: 61f0ad85-3001-41cb-824a-e6a047668dfe
                powerState: Running
                privateIP: 10.0.0.13
                macAddress: fa:16:3e:11:70:2f
    badRequestResponse:
      description: |-
        Request body failed schema validation, or the request does not contain
        all the required fields.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: invalid_request
            error_description: request body invalid
            trace_id: 57bc14d9bd461f0b5a72db830149b67a
    unauthorizedResponse:
      description: Authentication failed or the access token has expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: access_denied
            error_description: authentication failed
            trace_id: 57bc14d9bd461f0b5a72db830149b67a
    forbiddenResponse:
      description: >-
        Request was denied by authorization, this may be caused by the
        authorization

        token not having the required scope for an API, or the user doesn't have
        the

        necessary privileges on the provider platform.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: forbidden
            error_description: user credentials do not have the required privileges
            trace_id: 57bc14d9bd461f0b5a72db830149b67a
    notFoundResponse:
      description: Unable to find a resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: not_found
            error_description: the requested resource does not exist
            trace_id: 57bc14d9bd461f0b5a72db830149b67a
    internalServerErrorResponse:
      description: >-
        An unexpected or unhandled error occurred. This may be a transient error
        and

        may succeed on a retry.  If this isn't the case, please report it as an
        issue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: server_error
            error_description: failed to token claim
            trace_id: 57bc14d9bd461f0b5a72db830149b67a
  schemas:
    kubernetesNameParameter:
      description: >-
        A Kubernetes name. Must be a valid DNS label containing only lower case
        characters, numbers or hyphens, start and end with a character or
        number, and be at most 63 characters in length.
      type: string
      minLength: 1
      maxLength: 63
    placementServersV2Read:
      description: A list of placement servers.
      type: array
      items:
        $ref: '#/components/schemas/placementServerV2Read'
    error:
      description: Generic error message, compatible with oauth2.
      type: object
      required:
        - error
        - error_description
      properties:
        error:
          description: >-
            A terse error string expanding on the HTTP error code. Errors are
            based on the OAuth 2.02 specification, but are expanded with
            proprietary status codes for APIs other than those specified by
            OAuth 2.02.
          type: string
          enum:
            - invalid_request
            - server_error
            - access_denied
            - not_found
            - conflict
            - method_not_allowed
            - unsupported_media_type
            - request_entity_too_large
            - unprocessable_content
            - forbidden
        error_description:
          description: Verbose message describing the error.
          type: string
        trace_id:
          description: Unique trace identifier for the request.
          type: string
    placementServerV2Read:
      description: A placement server.
      type: object
      required:
        - metadata
        - status
      properties:
        metadata:
          $ref: '#/components/schemas/projectScopedResourceReadMetadata'
        status:
          $ref: '#/components/schemas/placementServerV2Status'
    projectScopedResourceReadMetadata:
      description: Metadata required by project scoped resource reads.
      allOf:
        - $ref: '#/components/schemas/organizationScopedResourceReadMetadata'
        - type: object
          required:
            - projectId
          properties:
            projectId:
              description: The project identifier the resource belongs to.
              type: string
    placementServerV2Status:
      description: Read only runtime status information about a placement server.
      type: object
      required:
        - regionId
        - reservationId
        - placementId
        - networkId
      properties:
        regionId:
          description: The region the placement server belongs to.
          type: string
        reservationId:
          description: The reservation the placement server allocates from.
          type: string
        placementId:
          description: The placement that owns this server.
          type: string
        networkId:
          description: The network the placement server belongs to.
          type: string
        powerState:
          $ref: '#/components/schemas/instanceLifecyclePhase'
        privateIP:
          description: The private IP address of the server.
          type: string
        publicIP:
          description: The public IP address of the server.
          type: string
        macAddress:
          description: The MAC address of the server.
          type: string
    organizationScopedResourceReadMetadata:
      description: Metadata required by organization scoped resource reads.
      allOf:
        - $ref: '#/components/schemas/resourceReadMetadata'
        - type: object
          required:
            - organizationId
          properties:
            organizationId:
              description: The organization identifier the resource belongs to.
              type: string
    instanceLifecyclePhase:
      description: |
        The lifecycle phase of an instance. Once provisioning_status reaches
        provisioned, this becomes the live readiness signal: API consumers
        should treat Running (not provisioned) as the "ready to use" state.
        Queued and Building are observed during create — Queued for
        baremetal servers waiting on hardware, Building for servers the
        provider is actively bringing up.
      type: string
      enum:
        - Pending
        - Queued
        - Building
        - Running
        - Stopping
        - Stopped
    resourceReadMetadata:
      description: Metadata required by all resource reads.
      allOf:
        - $ref: '#/components/schemas/staticResourceMetadata'
        - type: object
          required:
            - provisioningStatus
            - healthStatus
          properties:
            deletionTime:
              description: The time the resource was deleted.
              type: string
              format: date-time
            provisioningStatus:
              $ref: '#/components/schemas/resourceProvisioningStatus'
            healthStatus:
              $ref: '#/components/schemas/resourceHealthStatus'
    staticResourceMetadata:
      description: |
        This metadata is for resources that just exist, and don't require
        any provisioning and health status, but benefit from a standardized
        metadata format.
      type: object
      allOf:
        - $ref: '#/components/schemas/resourceMetadata'
        - type: object
          required:
            - id
            - creationTime
          properties:
            id:
              description: The unique resource ID.
              type: string
            creationTime:
              description: The time the resource was created.
              type: string
              format: date-time
            createdBy:
              description: The user who created the resource.
              type: string
            modifiedTime:
              description: The time a resource was updated.
              type: string
              format: date-time
            modifiedBy:
              description: The user who updated the resource.
              type: string
    resourceProvisioningStatus:
      description: The provisioning state of a resource.
      type: string
      enum:
        - unknown
        - pending
        - provisioning
        - provisioned
        - deprovisioning
        - error
    resourceHealthStatus:
      description: The health state of a resource.
      type: string
      enum:
        - unknown
        - healthy
        - degraded
        - error
    resourceMetadata:
      description: Metadata required for all API resource reads and writes.
      required:
        - name
      properties:
        name:
          $ref: '#/components/schemas/kubernetesLabelValue'
        description:
          description: >-
            The resource description, this optionally augments the name with
            more context.
          type: string
        tags:
          $ref: '#/components/schemas/tagList'
    kubernetesLabelValue:
      description: >-
        A valid Kubernetes label value, typically used for resource names that
        can be

        indexed in the database.
      type: string
      pattern: ^[0-9A-Za-z](?:[0-9A-Za-z-_.]{0,61}[0-9A-Za-z])?$
    tagList:
      description: A list of tags.
      type: array
      items:
        $ref: '#/components/schemas/tag'
    tag:
      description: >-
        A tag mapping arbitrary names to values.  These have no special meaning

        for any component are are intended for use by end users to add
        additional

        context to a resource, for example to categorize it.
      type: object
      required:
        - name
        - value
      properties:
        name:
          description: A unique tag name.
          type: string
        value:
          description: The value of the tag.
          type: string
  securitySchemes:
    oauth2Authentication:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth2/v2/authorization
          tokenUrl: /oauth2/v2/token
          scopes: {}

````