Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Health Report

Create or update Machine health report

Add or update health report override for a specific Machine.

For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN suffix.

For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled and Tenant Account with Machine's Provider. User must have authorization role with TENANT_ADMIN suffix.

put/v2/org/{org}/nico/machine/{machineId}/health-report

Request body

sourcestring required

Health report source.

mode'Merge' | 'Replace' required

How updates to this health report should be handled

Example request

{
  "source": "maintenance.dpu-reprovision",
  "mode": "Merge",
  "alerts": [
    {
      "id": "HostUpdateInProgress",
      "message": "DPU reprovisioning in progress",
      "classifications": [
        "PreventAllocations"
      ]
    }
  ]
}

Response

OK

sourcestring required

Health report source.

triggeredBystring

Person or system that triggered this health report.

observedAtstring date-time

Date/time when the health report was observed.

mode'Merge' | 'Replace' required

How this health report was updated

Example response

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