We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • cPanel API 2 Functions - SubDomain::validregex
Skip to end of metadata
Go to start of metadata



This function returns a regular expression to use to validate a subdomain.


We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.




 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Return a regex.
$validregex = $cpanel->api2(
    'SubDomain', 'validregex'


For more information, read our Guide to the LiveAPI System.


 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Return a regex.
my $validregex = $cpliveapi->api2(
    'SubDomain', 'validregex',


For more information, read our Guide to the LiveAPI System.


 cPanel Tag System (deprecated)


  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username SubDomain validregex


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:


 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "func": "validregex",
    "data": [
    "event": {
      "result": 1
    "module": "SubDomain"


Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.


This function does not accept parameters.


ReturnTypeDescriptionPossible valuesExample
dataarrayA Perl Compatible Regular Expression (PCRE) that the system uses to validate the subdomain. A valid PCRE.
 Click to view...

A reason for failure.


This function only returns a reason value if there was an error.

A string that describes the error.This is an error message.

Whether the function succeeded.

  • 1 — Success.
  • 0 — Failure.