Esx.Settings.StatusInfo

The Esx.Settings.StatusInfo schema contains properties that describe aggregated status of all checks performed on an entity.

JSON Example

{
    "status": "string",
    "check_statuses": [
        {
            "check": {
                "check": "string",
                "name": "Vapi.Std.LocalizableMessage Object",
                "description": "Vapi.Std.LocalizableMessage Object"
            },
            "status": "string",
            "originator": "string",
            "errors": [
                {
                    "description": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object"
                }
            ]
        }
    ]
}

string

status

Required

Aggregated status from all checks performed on this entity.

Possible values:

OK: The check indicates a success.
WARNING: The check indicates a warning.
TIMEOUT: The check did not return in a timely manner.
ERROR: The check indicates an error.
RETRY: The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

For more information see: Esx.Settings.Status.

array of Esx.Settings.CheckStatus

check_statuses

Required

List of Esx.Settings.CheckStatus for all checks performed.