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

# List device candidate IDs

> Return device IDs for the same filters as the device-candidates endpoint.

Accepts the same query parameters as ``device-candidates`` and returns an
unpaginated array of matching device IDs, capped by ``LIST_ALL_MAX_RESULTS``.
Computing the eligibility map is skipped entirely unless an ``eligible``
filter is supplied.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/eligibility/device-candidate-ids/
openapi: 3.0.3
info:
  title: Fleet Manager API
  version: 1.0.0
  description: API for the Nscale Fleet Manager
servers: []
security: []
paths:
  /api/v1/eligibility/device-candidate-ids/:
    get:
      tags:
        - Eligibility
      summary: List device candidate IDs
      description: >-
        Return device IDs for the same filters as the device-candidates
        endpoint.


        Accepts the same query parameters as ``device-candidates`` and returns
        an

        unpaginated array of matching device IDs, capped by
        ``LIST_ALL_MAX_RESULTS``.

        Computing the eligibility map is skipped entirely unless an ``eligible``

        filter is supplied.
      operationId: api_v1_eligibility_device_candidate_ids_retrieve
      parameters:
        - in: query
          name: allocation_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: chad_ignore
          schema:
            type: boolean
        - in: query
          name: cordon_only
          schema:
            type: boolean
          description: >-
            Evaluate Quarantine eligibility for a cordon-only run, which removes
            the customer-ready trait without adopting the node or touching its
            instance. Widens readiness to an in-use or available node with an
            active instance. Ignored by workflows that do not explicitly support
            this readiness path.
        - in: query
          name: current_instance_uuid
          schema:
            type: string
        - in: query
          name: current_tenant_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: customer_ready
          schema:
            type: boolean
        - in: query
          name: device_class
          schema:
            type: array
            items:
              type: string
              enum:
                - cpu_baremetal
                - cpu_hypervisor
                - gpu_compute
                - switch
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: device_group_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: device_type_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: eligible
          schema:
            type: boolean
          description: >-
            Filter by eligibility. true=eligible only, false=ineligible only.
            Omit to return all.
        - in: query
          name: force_rebuild
          schema:
            type: boolean
          description: >-
            Evaluate Quarantine eligibility for in-place rebuild of an
            already-adopted node. Widens readiness to an active node with an
            instance, without the in-use requirement force_reclaim carries.
            Ignored by workflows that do not explicitly support this readiness
            path.
        - in: query
          name: force_reclaim
          schema:
            type: boolean
          description: >-
            Evaluate Quarantine eligibility for destructive force reclaim.
            Ignored by workflows that do not explicitly support this readiness
            path.
        - in: query
          name: health_status
          schema:
            type: array
            items:
              type: string
              enum:
                - critical
                - degraded
                - healthy
                - unknown
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: in_triage
          schema:
            type: boolean
        - in: query
          name: infrastructure_ref
          schema:
            type: string
        - in: query
          name: infrastructure_ref__startswith
          schema:
            type: string
        - in: query
          name: inventory_only
          schema:
            type: boolean
        - in: query
          name: inventory_status
          schema:
            type: array
            items:
              type: string
              enum:
                - active
                - decommissioned
                - decommissioning
                - failed
                - inventory
                - offline
                - planned
                - returned
                - rma
                - staged
                - unknown
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: ironic_provision_state
          schema:
            type: array
            items:
              type: string
              enum:
                - active
                - adopt failed
                - adopting
                - available
                - clean failed
                - clean hold
                - clean wait
                - cleaning
                - deleted
                - deleting
                - deploy complete
                - deploy failed
                - deploy hold
                - deploying
                - enroll
                - error
                - inspect failed
                - inspect wait
                - inspecting
                - manageable
                - rebuild
                - rescue
                - rescue failed
                - rescue wait
                - rescuing
                - service
                - service failed
                - service hold
                - service wait
                - servicing
                - unknown
                - unrescue failed
                - unrescuing
                - verifying
                - wait call-back
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: job_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: location_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: name
          schema:
            type: string
        - in: query
          name: name_exact
          schema:
            type: string
        - in: query
          name: netbox_id
          schema:
            type: integer
        - in: query
          name: operational_status
          schema:
            type: array
            items:
              type: string
              enum:
                - available
                - delegated
                - drained
                - failed
                - in_use
                - pending_handover
                - quarantine
                - unknown
                - validation
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: rack_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: role_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: serial_number
          schema:
            type: string
        - in: query
          name: site_id
          schema:
            type: string
            format: uuid
          description: Site to scope candidate devices to.
          required: true
        - in: query
          name: slurm_states
          schema:
            type: array
            items:
              type: string
              enum:
                - ALLOCATED
                - BLOCKED
                - CLOUD
                - COMPLETING
                - DOWN
                - DRAIN
                - DYNAMIC_FUTURE
                - DYNAMIC_NORM
                - ERROR
                - FAIL
                - FUTURE
                - IDLE
                - INVALID_REG
                - MAINTENANCE
                - MIXED
                - NOT_RESPONDING
                - PLANNED
                - POWERED_DOWN
                - POWERING_DOWN
                - POWERING_UP
                - POWER_DOWN
                - POWER_DRAIN
                - POWER_UP
                - REBOOT_CANCELED
                - REBOOT_ISSUED
                - REBOOT_REQUESTED
                - RESERVED
                - RESUME
                - UNDRAIN
                - UNKNOWN
          description: >-
            SLURM node states. A device matches when its own state list contains
            any of these. Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: topology_group_id
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: topology_group_id_strict
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Multiple values may be separated by commas.
          explode: false
          style: form
        - in: query
          name: workflow_id
          schema:
            type: string
            format: uuid
          description: Workflow to evaluate eligibility against.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  format: uuid
          description: ''
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - workflow:read
            - device:read
        - cookieAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      description: >-
        Uniform error body for every 4xx/5xx response. `detail` is a
        human-readable message, always present, safe to display to end users.
        `code` is the machine-readable identifier. `field_errors` lists
        per-input-field validation messages and is empty for non-field errors
        (auth, permission, not-found, conflict, server).
      required:
        - detail
        - code
        - field_errors
      properties:
        detail:
          type: string
        code:
          $ref: '#/components/schemas/ErrorCodeEnum'
        field_errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    ErrorCodeEnum:
      type: string
      description: >-
        Stable machine-readable error identifier. New members may be added
        within this API version; clients must tolerate unknown values.
      enum:
        - error
        - invalid
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - conflict
        - enrollment_infrastructure_reference_pending
        - enrollment_infrastructure_reference_changed
        - unprocessable_entity
        - throttled
        - service_unavailable
    FieldError:
      type: object
      description: One input field's validation messages.
      required:
        - field
        - messages
      properties:
        field:
          type: string
          description: >-
            Dotted path to the offending input field, or to the collection row
            when the whole row is invalid (e.g. `filters.end_date`,
            `memberships.0.role`, `memberships.0`).
        messages:
          type: array
          minItems: 1
          items:
            type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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