Validate Trays

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/tray/validation

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.

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.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site

rackIdstringOptional

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

rackNamestringOptional

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

namestringOptional

Filter trays by name

manufacturerstringOptional

Filter trays by manufacturer

typeenumOptional

Filter trays by type. When id is specified, the type disambiguates component IDs shared by different component types.

Allowed values:

idstringOptional

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

slotIdintegerOptional>=0

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

diffslist of objectsOptional

List of component differences found during validation

totalDiffsintegerOptional

Total number of component differences found

missingCountintegerOptional

Number of components expected but missing from the source system

unexpectedCountintegerOptional

Number of components found in the source system but not expected

mismatchCountintegerOptional

Number of components present in both but with field differences

matchCountintegerOptional

Number of components that match between expected and actual

Errors

400

Bad Request Error

403

Forbidden Error

504

Gateway Timeout Error