Retrieve all Rack health reports

GET

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

GET

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

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/rack/id/health-report \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d siteId=siteId

[
  {
    "source": "maintenance.dpu-reprovision",
    "mode": "Merge",
    "triggeredBy": "operator_jane_doe",
    "observedAt": "2024-01-15T09:30:00Z",
    "successes": [
      {
        "id": "FanSpeed",
        "target": "System Board Fan1A"
      }
    ],
    "alerts": [
      {
        "id": "HostUpdateInProgress",
        "message": "DPU reprovisioning in progress",
        "target": "DPU Module 3",
        "inAlertSince": "2024-01-15T09:30:00Z",
        "tenantMessage": "Scheduled maintenance ongoing",
        "classifications": [
          "PreventAllocations"
        ]
      }
    ]
  }
]

Get all health report overrides for a specific Rack.

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

Path parameters

orgstringRequired

Name of the Org

idstringRequired

ID of the Rack

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the Rack

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