Developer Documentation
Child pages
  • WHM API 1 Functions - validate_system_user
Skip to end of metadata
Go to start of metadata

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function validates a system user for use on the target server.

Examples 

 JSON API

https://hostname.example.com:2087/cpsess##########/json-api/validate_system_user?api.version=1&user=username

 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/validate_system_user?api.version=1&user=username
 Command Line
whmapi1 validate_system_user user=username


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)

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

 Output (XML)
<result>
    <data>
        <valid_for_transfer>1</valid_for_transfer>
        <reserved>1</reserved>
        <exists>1</exists>
        <valid_for_new>1</valid_for_new>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>validate_system_user</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
user
string

Required

The system username.

A valid username.
username

Returns

ReturnTypeDescriptionPossible valuesExample

valid_for_transfer

BooleanWhether the username is valid for a transferred account, but not a new account.
  • 1 — Valid for transfer, but not a new account.
  • 0 — Invalid.
1
reservedBooleanWhether the username is reserved.
  • 1 — Reserved.
  • 0 — Not reserved.
1
existsBooleanWhether the username exists on the server.
  • 1 — Exists.
  • 0 — Does not exist.
1
valid_for_newBooleanWhether the system can use the username to create a new account.
  • 1 — Usable.
  • 0 — Unusable.
1

Function information

API Version:

WHM API 1

Available in:

WHM 11.44+

Methods:

GET, POST

Required Parameters:

user

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions

 

 

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.