> ## 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. # Check eligibility for a device set > Pre-flight eligibility check for a specific set of devices. ## OpenAPI ````yaml /openapi/fleet-manager-openapi.yaml post /api/v1/eligibility/check/ 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/check/: post: tags: - Eligibility summary: Check eligibility for a device set description: Pre-flight eligibility check for a specific set of devices. operationId: api_v1_eligibility_check_create requestBody: content: application/json: schema: $ref: '#/components/schemas/EligibilityCheckRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EligibilityCheckRequest' multipart/form-data: schema: $ref: '#/components/schemas/EligibilityCheckRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EligibilityCheckResponse' 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: EligibilityCheckRequest: type: object description: Request body for the pre-flight eligibility check endpoint. properties: workflow_id: type: string format: uuid device_ids: type: array items: type: string format: uuid minItems: 1 parameters: type: object description: >- Workflow parameters to evaluate eligibility under, keyed by parameter name. The accepted keys are defined by the target workflow's own parameters schema. additionalProperties: $ref: '#/components/schemas/JsonValue' required: - device_ids - workflow_id EligibilityCheckResponse: type: object description: Response body for the pre-flight eligibility check endpoint. properties: is_eligible: type: boolean issues: type: array items: $ref: '#/components/schemas/EligibilityCheckIssue' required: - is_eligible - issues 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' JsonValue: description: Any JSON value. nullable: true anyOf: - type: string - type: number - type: integer - type: boolean - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' EligibilityCheckIssue: type: object description: A single eligibility issue returned by the cohort check endpoint. properties: code: $ref: '#/components/schemas/CodeEnum' message: type: string scope: $ref: '#/components/schemas/ScopeEnum' severity: $ref: '#/components/schemas/SeverityEnum' device_ids: type: array items: type: string format: uuid condition_type: $ref: '#/components/schemas/DeviceConditionTypeEnum' required: - code - device_ids - message - scope - severity 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 CodeEnum: enum: - inventory_status_not_allowed - operational_status_not_allowed - device_class_not_allowed - device_count_out_of_range - resource_class_missing - resource_class_mismatch - device_site_mismatch - active_workflow_conflict - device_in_triage - device_not_placed - device_inventory_only - ironic_node_not_ready - condition_prerequisite_missing - condition_prerequisite_false - condition_prerequisite_unknown - condition_disqualifier_asserted - condition_disqualifier_unproven - device_has_active_jobs - enrollment_proof_missing - topology_sync_not_healthy type: string description: |- * `inventory_status_not_allowed` - inventory_status_not_allowed * `operational_status_not_allowed` - operational_status_not_allowed * `device_class_not_allowed` - device_class_not_allowed * `device_count_out_of_range` - device_count_out_of_range * `resource_class_missing` - resource_class_missing * `resource_class_mismatch` - resource_class_mismatch * `device_site_mismatch` - device_site_mismatch * `active_workflow_conflict` - active_workflow_conflict * `device_in_triage` - device_in_triage * `device_not_placed` - device_not_placed * `device_inventory_only` - device_inventory_only * `ironic_node_not_ready` - ironic_node_not_ready * `condition_prerequisite_missing` - condition_prerequisite_missing * `condition_prerequisite_false` - condition_prerequisite_false * `condition_prerequisite_unknown` - condition_prerequisite_unknown * `condition_disqualifier_asserted` - condition_disqualifier_asserted * `condition_disqualifier_unproven` - condition_disqualifier_unproven * `device_has_active_jobs` - device_has_active_jobs * `enrollment_proof_missing` - enrollment_proof_missing * `topology_sync_not_healthy` - topology_sync_not_healthy ScopeEnum: enum: - device - cohort - parameters type: string description: |- * `device` - device * `cohort` - cohort * `parameters` - parameters SeverityEnum: enum: - error - warning type: string description: |- * `error` - error * `warning` - warning DeviceConditionTypeEnum: enum: - ProvisioningHealthy - MaintenanceClear - Enrolled - InValidationPool - InstanceAllocated - CustomerAllocated - CustomerReady - SlurmMember - SlurmSchedulable - TelemetryHealthy - SystemHealthy - ChassisHealthy - ProcessorHealthy - MemoryHealthy - StorageHealthy - DiskHealthy - PowerSupplyHealthy - GpuHealthy - FpgaHealthy - CustodyIntent - FrontendPortsInCustomerVrf - NvLinkGpusInRepairPartition - BackendPortsInMaintenanceVrf type: string description: |- * `ProvisioningHealthy` - Provisioning healthy * `MaintenanceClear` - Maintenance clear * `Enrolled` - Enrolled * `InValidationPool` - In validation pool * `InstanceAllocated` - Instance allocated * `CustomerAllocated` - Customer allocated * `CustomerReady` - Customer ready * `SlurmMember` - Slurm member * `SlurmSchedulable` - Slurm schedulable * `TelemetryHealthy` - Telemetry healthy * `SystemHealthy` - System healthy * `ChassisHealthy` - Chassis healthy * `ProcessorHealthy` - Processor healthy * `MemoryHealthy` - Memory healthy * `StorageHealthy` - Storage healthy * `DiskHealthy` - Disk healthy * `PowerSupplyHealthy` - Power supply healthy * `GpuHealthy` - GPU healthy * `FpgaHealthy` - FPGA healthy * `CustodyIntent` - Custody intent * `FrontendPortsInCustomerVrf` - Front-end ports in customer VRF * `NvLinkGpusInRepairPartition` - GPUs in NVLink repair partition * `BackendPortsInMaintenanceVrf` - Back-end ports in maintenance VRF 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.