Check Root Password Expiration

Check Root Password Expiration

This request checks how many seconds are left before the appliance root password expires and whether the password is expired or not.

Request
URI
GET
https://{api_host}/config/root-password-expired
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RootPasswordExpired of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "rootPasswordExpired": false,
    "secondsUntilExpiration": 5000
}
boolean
rootPasswordExpired
Optional

Whether the root password is expired.

integer As int64 As int64
secondsUntilExpiration
Optional

Seconds until the root appliance password expires.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.