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

# List servers that can join an allocated node pool

> Lists a project's servers at a site, with whether each one can join an allocated node pool right now. Pass the `id` of an allocatable server in `server_ids` when creating or updating an allocated node pool.

When `allocatable` is false, `reasons` lists why, using the same codes that node pool create and update return per server. `node_pool_id` and `cluster_id` identify the pool a server already belongs to.




## OpenAPI

````yaml https://spec.speakeasy.com/latitude/latitude/latitude-sh-api-with-code-samples get /lks/allocatable_servers
openapi: 3.0.1
info:
  title: Latitude.sh API
  version: '2023-06-01'
  description: >-
    The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It
    allows you to perform the same actions as the Latitude.sh dashboard.
servers:
  - url: https://api.latitude.sh
    variables:
      latitude_api_key:
        default: <insert your api key here>
  - url: http://api.latitude.sh
    variables:
      latitude_api_key:
        default: <insert your api key here>
security: []
tags:
  - name: API keys
  - name: Baselines (Preview)
    description: >-
      Preview. Available to teams with the `baselines_api` feature flag. The
      shape of these endpoints may change before general availability.
  - name: Billing
  - name: Elastic Ips
  - name: Events
  - name: Firewalls
  - name: IP Addresses
  - name: Managed Databases
    description: Managed database instances (PostgreSQL, ClickHouse)
  - name: Kubernetes Clusters
  - name: LKS
  - name: Marketplace apps
  - name: Operating Systems
  - name: Plans
  - name: Public Networks
  - name: Private Networks
  - name: Projects
  - name: Regions
  - name: Roles
  - name: SSH Keys
  - name: Servers
  - name: Block Storage
  - name: Filesystem Storage
  - name: Object Storage
  - name: Tags
  - name: Teams
  - name: Team members
  - name: Traffic
  - name: User data
  - name: User profile
  - name: VPN Sessions
  - name: Virtual machines
  - name: Virtual machine backups
  - name: Virtual machine restores
paths:
  /lks/allocatable_servers:
    get:
      tags:
        - LKS
      summary: List servers that can join an allocated node pool
      description: >
        Lists a project's servers at a site, with whether each one can join an
        allocated node pool right now. Pass the `id` of an allocatable server in
        `server_ids` when creating or updating an allocated node pool.


        When `allocatable` is false, `reasons` lists why, using the same codes
        that node pool create and update return per server. `node_pool_id` and
        `cluster_id` identify the pool a server already belongs to.
      operationId: list-lks-allocatable-servers
      parameters:
        - name: filter[project]
          in: query
          required: true
          description: Project id or slug
          schema:
            type: string
        - name: filter[site]
          in: query
          required: true
          description: Site slug
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              examples:
                TwoServers:
                  value:
                    data:
                      - id: sv_9dQKr1pRMLyd
                        type: lks_allocatable_servers
                        attributes:
                          hostname: gpu-box-1
                          plan:
                            slug: g3-large-x86
                            name: g3.large.x86
                          status: 'on'
                          allocatable: true
                          reasons: []
                          node_pool_id: null
                          cluster_id: null
                      - id: sv_pRMLydp0dQKr1
                        type: lks_allocatable_servers
                        attributes:
                          hostname: gpu-box-2
                          plan:
                            slug: g3-large-x86
                            name: g3.large.x86
                          status: 'on'
                          allocatable: false
                          reasons:
                            - SERVER_LOCKED_ERROR
                          node_pool_id: null
                          cluster_id: null
                    meta:
                      total: 2
              schema:
                $ref: '#/components/schemas/lks_allocatable_servers'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              examples:
                ProjectNotFound:
                  value:
                    errors:
                      - code: NOT_FOUND
                        title: Not Found
                        detail: Project 'proj_6059EqYkOQj8p' not found
                        status: '404'
                        meta: {}
                FilterMissing:
                  summary: '`filter[project]` or `filter[site]` is missing'
                  value:
                    errors:
                      - code: NOT_FOUND
                        title: Not Found
                        detail: filter[project] is required
                        status: '404'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
        '422':
          description: Unprocessable Entity
          content:
            application/vnd.api+json:
              examples:
                ReservedProjectNotSupported:
                  value:
                    errors:
                      - code: RESERVED_PROJECT_NOT_SUPPORTED
                        title: Reserved Project Not Supported
                        detail: >-
                          Allocated node pools are only available in on-demand
                          projects
                        status: '422'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
        '502':
          description: Bad Gateway — NetBox is temporarily unavailable
          content:
            application/vnd.api+json:
              examples:
                UpstreamServiceError:
                  value:
                    errors:
                      - code: UPSTREAM_SERVICE_ERROR
                        title: Bad Gateway
                        detail: NetBox is temporarily unavailable. Please try again.
                        status: '502'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
      security:
        - Bearer: []
      x-codeSamples:
        - lang: go
          label: Go (SDK)
          source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tlatitudeshgosdk \"github.com/latitudesh/latitudesh-go-sdk\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := latitudeshgosdk.New(\n        latitudeshgosdk.WithSecurity(os.Getenv(\"LATITUDESH_BEARER\")),\n    )\n\n    res, err := s.Lks.ListLksAllocatableServers(ctx, \"<value>\", \"<value>\")\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.LksAllocatableServers != nil {\n        // handle response\n    }\n}"
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { Latitudesh } from "latitudesh-typescript-sdk";

            const latitudesh = new Latitudesh({
              bearer: process.env["LATITUDESH_BEARER"] ?? "",
            });

            async function run() {
              const result = await latitudesh.lks.listLksAllocatableServers({
                filterProject: "<value>",
                filterSite: "<value>",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    lks_allocatable_servers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/lks_allocatable_server_data'
        meta:
          type: object
          properties:
            total:
              type: integer
    error_object:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                nullable: true
              status:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
                  parameter:
                    type: string
              meta:
                type: object
    lks_allocatable_server_data:
      type: object
      properties:
        id:
          type: string
          example: sv_9dQKr1pRMLyd
          description: Server id — pass it in `server_ids`
        type:
          type: string
          enum:
            - lks_allocatable_servers
        attributes:
          type: object
          properties:
            hostname:
              type: string
              nullable: true
              example: gpu-box-1
            plan:
              type: object
              properties:
                slug:
                  type: string
                  nullable: true
                  example: g3-large-x86
                name:
                  type: string
                  nullable: true
                  example: g3.large.x86
            status:
              type: string
              nullable: true
              example: 'on'
            allocatable:
              type: boolean
              description: >-
                true when the server can be added to an allocated node pool
                right now
            reasons:
              type: array
              items:
                type: string
                example: SERVER_LOCKED_ERROR
              description: >-
                Why the server is not allocatable; empty when it is. Open set:
                the same codes a node pool create/update returns per server
                (SERVER_NOT_BGP_ENABLED, SERVER_IN_LKS_NODE_POOL,
                SERVER_LOCKED_ERROR, ...)
            node_pool_id:
              type: string
              nullable: true
              example: lksnp_9dQKr1pRMLyd
              description: The node pool the server already belongs to, when it does
            cluster_id:
              type: string
              nullable: true
              example: lksc_9dQKr1pRMLyd
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.