Create or update Tray health report

PUT

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/tray/:id/health-report

PUT

/v2/org/:org/nico/tray/:id/health-report

curl -X PUT https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/tray/id/health-report \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "type": "PowerShelf",
  "source": "overrides.sre",
  "mode": "Merge",
  "alerts": [
    {
      "id": "PowerShelfMaintenanceInProgress",
      "message": "Power Shelf maintenance in progress",
      "classifications": [
        "PreventAllocations"
      ]
    }
  ]
}'

{
  "source": "maintenance.dpu-reprovision",
  "mode": "Merge",
  "triggeredBy": "operator",
  "observedAt": "2026-06-24T12:00:00Z",
  "alerts": [
    {
      "id": "HostUpdateInProgress",
      "message": "DPU reprovisioning in progress",
      "classifications": [
        "PreventAllocations"
      ]
    }
  ]
}

Add or update a health report override for a specific Tray. Compute targets the Machine health report, NVSwitch targets the Switch health report, and PowerShelf targets the Power Shelf health report. If the Tray ID uses a recognized component namespace that conflicts with type, the request returns 400. If a valid ID in the selected namespace does not identify an existing resource, the request returns 404.

Org must have an Infrastructure Provider entity that owns the Site. User must have authorization role with PROVIDER_ADMIN suffix.

Add or update a health report override for a specific Tray. `Compute` targets the Machine health report, `NVSwitch` targets the Switch health report, and `PowerShelf` targets the Power Shelf health report. If the Tray ID uses a recognized component namespace that conflicts with `type`, the request returns 400. If a valid ID in the selected namespace does not identify an existing resource, the request returns 404. Org must have an Infrastructure Provider entity that owns the Site. 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

idstringRequired

Component ID of the Tray

Request

This endpoint expects an object.

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the Tray.

typeenumRequired

Tray type used to select the corresponding component health-report resource.

Allowed values:

sourcestringRequired

Health report source.

modeenumRequired

How updates to this health report should be handled

Allowed values:

successeslist of objectsOptional

Results from successful health probes for the Tray.

alertslist of objectsOptional

Results from failed health probes for the Tray.

Response

sourcestring

Health report source.

modeenum

How this health report was updated

Allowed values:

triggeredBystringOptional

Person or system that triggered this health report.

observedAtdatetimeOptional

Date/time when the health report was observed.

successeslist of objectsOptional

Results from successful health probes for the Machine.

alertslist of objectsOptional

Results from failed health probes for the Machine.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

504

Gateway Timeout Error