Messages Health
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Get health messages.
Request
URLURL
https://{api_host}/rest/appliance/health/{item}/messages
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | ID of the data item The parameter must be an identifier for the resource type: com.vmware.appliance.health. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
HealthMessagesResponseBody
of type application/json
List of the health messages
{
"value": [
{
"id": "string",
"time": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of Notification |
List of the health messages |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/health/{item}/messages
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : Unknown health item | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
