Validate username during restoration

This function checks for username conflicts during account restoration. If the function detects a username conflict, it outputs an error message in the reason return.

SecurityBasicAuth
Request
query Parameters
user
required
string

The cPanel account that you wish to transfer to the server.

Example: user=username
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/verify_new_username_for_restore
Request samples
whmapi1 --output=jsonpretty \
  verify_new_username_for_restore \
  user='username'
Response samples
application/json
{
  • "metadata": {
    • "command": "verify_new_username_for_restore",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}