v57

OpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

Tray

Validate Trays

Validate Tray components by comparing expected vs actual state.

If no filter is specified, validates all trays in the Site. Use rackId/rackName to scope to a specific rack, and name/manufacturer/type to filter by tray attributes.

Compares the expected component configuration against the actual state. Returns a detailed diff report showing missing, extra, and mismatched components.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/tray/validation

Query parameters

siteIdstring uuid required

ID of the Site

rackIdstring uuid

Scope to a specific Rack by ID (mutually exclusive with rackName)

rackNamestring

Scope to a specific Rack by name (mutually exclusive with rackId)

namestring

Filter trays by name

manufacturerstring

Filter trays by manufacturer

type'compute' | 'switch' | 'powershelf'

Filter trays by type

componentIdstring

Filter by external component ID (requires type; mutually exclusive with rackId/rackName; use repeated params for multiple values)

slotIdinteger

Restrict validation to trays at this rack slot (matches position.slotId). Requires rackId or rackName. Composes with the rest of the filter via AND.

Response

totalDiffsinteger

Total number of component differences found

missingCountinteger

Number of components expected but missing from the source system

unexpectedCountinteger

Number of components found in the source system but not expected

mismatchCountinteger

Number of components present in both but with field differences

matchCountinteger

Number of components that match between expected and actual