API ReferenceTray

Validate a Tray

View as Markdown

Validate a Tray by comparing expected vs actual state.

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 ```

Path parameters

orgstringRequired
Name of the Org
idstringRequiredformat: "uuid"
ID of the Tray

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site

Response

OK
diffslist of objects
List of component differences found during validation
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

Errors

400
Bad Request Error
403
Forbidden Error