Change Root Password

Change Root Password

This request changes the root user password of the appliance.

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

Operation ID for correlating logs across multiple services

string
Config-Secret
Optional

The current password.

Config-Secret example
mycurrentpassword
Request Body

New password request.

ChangeRootPasswordRequest of type(s) application/json
Required 
{
    "rootPassword": "mynewpassword"
}
string
rootPassword
Optional

New root password.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

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.


On This Page
Configs Operations
POST
Change Root Password
GET
Check Root Password Expiration
GET
Config Is Configured
POST
Config Site
POST
Config Vcd
GET
Configure Get
GET
Configure Get Endpoints
POST
Configure Set Lookup Service
POST
Configure Update Endpoints