Get Installer Info

Get Installer Info
Retrieve Installer Appliance metadata and version

Returns diagnostic information about the Platform Installer appliance itself.

Returns:

  • FQDN of the installer appliance.
  • Active software version of the installer.
  • Current operational status of the installer daemon.

Notes:

  • This endpoint is independent and does not require any deployed Platform instances to function.
Request
URI
GET
https://{api_host}/https://{api_host}:{port}/lh-appliance/info
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Installer information retrieved successfully.

Returns InstallerInfo of type(s) application/json 
{
    "fqdn": {
        "name": "string",
        "state": "string",
        "ip": "string"
    },
    "version": "string",
    "status": "string"
}
object
fqdn
Optional

The FQDN of the Platform Ingress.

string
version
Read-Only

The version of the Platform Installer.

string
status
Optional

Enum for the overall platform status.

Enumeration: INITIALIZED, DEPLOYING, DEPLOYED, ERROR, UNDEPLOYING

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

An error occurred while retrieving installer information.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/info
On This Page
Diagnostic Operations
GET
Get Platform Health Status
GET
Get Installer Info