latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Transfers
Transfer Configuration

Validate username availability on target server

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.

get/validate_system_user

Query parameters

userstring required
Example:username

The system username.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "exists": 1,
    "reserved": 1,
    "valid_for_new": 1,
    "valid_for_transfer": 1
  },
  "metadata": {
    "command": "validate_system_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}