> ## 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 hardware descriptors

> List every hardware descriptor in stable platform-class order.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/hardware-descriptors/
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/hardware-descriptors/:
    get:
      tags:
        - Inventory
      summary: List hardware descriptors
      description: List every hardware descriptor in stable platform-class order.
      operationId: api_v1_hardware_descriptors_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
            maximum: 500
            minimum: 1
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedHardwareDescriptorListItemList'
          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:
            - hardware-descriptor:read
        - cookieAuth: []
components:
  schemas:
    PaginatedHardwareDescriptorListItemList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/HardwareDescriptorListItem'
    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'
    HardwareDescriptorListItem:
      type: object
      description: One descriptor paired with the platform class that keys it.
      properties:
        platform_class:
          type: string
          pattern: ^[A-Z0-9]+_[A-Z0-9]+_[A-Z0-9]+_[0-9]{2}$
        descriptor:
          $ref: '#/components/schemas/HardwareDescriptor'
      required:
        - descriptor
        - platform_class
    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
    HardwareDescriptor:
      type: object
      description: The canonical physical-device inventory for one platform class.
      properties:
        description:
          type: string
          minLength: 1
        devices:
          type: array
          items:
            $ref: '#/components/schemas/HardwareDescriptorEntry'
      required:
        - description
        - devices
    HardwareDescriptorEntry:
      type: object
      description: One physical device in a hardware descriptor.
      properties:
        kind:
          $ref: '#/components/schemas/HardwareDescriptorEntryKindEnum'
        model:
          type: string
          minLength: 1
        pci_address:
          type: string
          pattern: ^[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7]$
        numa_node:
          type: integer
          nullable: true
        gpu_pci_address:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7]$
      required:
        - gpu_pci_address
        - kind
        - model
        - numa_node
        - pci_address
    HardwareDescriptorEntryKindEnum:
      enum:
        - gpu
        - rdma_nic
        - frontend_nic
        - storage
      type: string
      description: |-
        * `gpu` - gpu
        * `rdma_nic` - rdma_nic
        * `frontend_nic` - frontend_nic
        * `storage` - storage
  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.