This function validates a system user for use on the target server.
Note:
For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.
user required | string The system username. Example: user=username |
object | |
object |
whmapi1 --output=jsonpretty \ validate_system_user \ user='username'
{- "data": {
- "exists": 1,
- "reserved": 1,
- "valid_for_new": 1,
- "valid_for_transfer": 1
}, - "metadata": {
- "command": "validate_system_user",
- "reason": "OK",
- "result": 1,
- "version": 1
}
}