Get Appliance Info

Get Appliance Info

Get appliance information such as the version and the appliance's role.

Request
URI
GET
https://{api_host}/v1/system/appliance-info
COPY
Responses
200

OK

Returns ApplianceInfo of type(s) application/json
{
    "role": "One of: VcfInstaller, SddcManager",
    "version": "9.0.0.0.1234567"
}
string
role
Optional

Appliance Role

string
version
Optional

Appliance version


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/system/appliance-info