Skip to content
WHM API1
/
Domain Management

WHM API (11.134.0.5)

WHM API.

https://cpanel.net/developers/
Download OpenAPI description
whm.openapi.json
whm.openapi.yaml
Overview
URL

https://cpanel.net/support/

WebPros International, LLC

cs@cpanel.net

License

cPanel License

Terms of Service

Languages
Servers
Mock server

https://api.docs.cpanel.net/_mock/specifications/whm.openapi/

A server running WHM.

https://{host}:{port}/json-api/

Restore Account

Account Restoration / Restore Account

Operations

Restore Queue Management

Account Restoration / Restore Queue Management

Operations

Restore Queue Reporting

Account Restoration / Restore Queue Reporting

Operations

Account Creation

Accounts Creation / Accounts

Operations

Account Enhancements

Accounts / Account Enhancements

Operations

Account Management

Accounts / Account Management

Operations

Bandwidth and Disk Quotas

Accounts / Bandwidth and Disk Quotas

Operations

Domain Information

Accounts / Domain Domain Information

Operations

Passwords

Accounts / Passwords

Operations

Styles

The Styles and Themes module for WHM API 1.

Operations

Suspensions

Accounts / Suspensions

Operations

API Execution

API Development Tools / API Execution

Operations

API Statistics

API Development Tools / API Statistics

Operations

API Token Management

API Development Tools / API Token Management

Operations

Applications

API Development Tools / Applications

Operations

Session

API Development Tools / Session

Operations

Authentication Providers

Authentication / Authentication Providers

Operations

External Authentication

Authentication / External Authentication

Operations

Login URL

Authentication / Login URL

Operations

SSH Keys and Connections

Authentication / SSH Keys and Connections

Operations

Two-Factor Authentication

Authentication / Two-Factor Authentication

Operations

Backup Destination

Backups / Backup Destination

Operations

Backup or Restore

Backups / Backup or Restore

Operations

Backup Settings

Backups / Backup Settings

Operations

Legacy Migration

Backups / Legacy Migration

Operations

Market Integration

Commerce Integration / Market Integration

Operations

Sitejet

The Sitejet module for WHM API.

Operations

Product Management

cPanel Market / Product Management

Operations

Provider Management

cPanel Market / Provider Management

Operations

Support Access

cPanel Support Tickets / Support Access

Operations

Ticket Management

cPanel Support Tickets / Ticket Management

Operations

Customizations

The Customizations module for WHM API 1.

Operations

Manage MySQL Server

Databases / Manage MySQL Server

Operations

MySQL Databases

Databases / MySQL Databases

Operations

PostgreSQL Databases

Databases / PostgreSQL Databases

Operations

Remote MySQL Databases

Databases / Remote MySQL Databases

Operations

DNS Cluster Settings

DNS / DNS Cluster Settings

Operations

DNS Security

DNS / DNS Security

Operations

DNS Zones

DNS / DNS Zones

Operations

Domain Management

DNS / Domain Management

Operations

Create DNS zone record

Request

This function adds a DNS zone record.

Important:

  • When you call this function, you must include the additional parameters for the selected zone record type.
  • When you disable the DNS role, the system disables this function.

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
Security
BasicAuth
Bodyapplication/x-www-form-urlencoded
classstringrequired

The record's class.

Example: "IN"
One of:

The record's class.

string

The record's class.

Value"IN"
domainstring(domain)required

The new zone record's domain.

Example: "example.com"
namestring(domain)required

The record's name.

Note:

Do not omit any necessary trailing periods.

You cannot use this function to add temporary domains.

Example: "hostname.example.com."
ttlinteger>= 1

The record's Time To Live (TTL), in seconds.

Default 86400
Example: 86400
typestringrequired

The DNS record type:

  • A - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.
  • A6 - A6 records store IPv6 addresses.
  • AAAA - AAAA records store IPv6 addresses.
  • AFSDB - AFSDB records store the location of an AFS cell's database servers.
  • ALIAS - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.
  • CAA - CAA records control which certificate authorities can issue SSL certificates for a domain.
  • CNAME - CNAME records create an alias to another hostname.
  • DNAME - DNAME records create an alias for a hostname and its subnames.
  • DS - DS records specify a record's delegation signer.
  • HINFO - HINFO records specify a host's CPU and OS types.
  • LOC - LOC records store a hostname's geographical location.
  • MX - MX records point a domain name to its MTAs.
  • NS - NS records store a domain's authoritative nameservers.
  • PTR - PTR records point to a CNAME.
  • RP - RP records store a domain's Responsible Person's information.
  • SOA - SOA records designate the beginning of a zone of authority.
  • SRV - SRV records store the service location records for newer protocols (for example, Autodiscover).
  • TXT - TXT records store descriptive text or useful records (for example, SPF or DKIM records).

When you call this function, you must include the additional parameters for the desired zone record type. Select a zone record from the menu to view the required additional parameters:

Enum"A""A6""AAAA""AFSDB""ALIAS""CAA""CNAME""DNAME""DS""HINFO"
Example: "A"
Discriminator
addressstring(ipv4)

The zone record's IPv4 address.

Note:

For more information about A records, read RFC 1035 at IANA.

Example: "192.168.0.20"
curl -i -X POST \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/whm.openapi/addzonerecord \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d class=IN \
  -d domain=example.com \
  -d name=hostname.example.com. \
  -d ttl=86400 \
  -d type=A \
  -d address=192.168.0.20

Responses

HTTP Request was successful.

Bodyapplication/json
metadataobject
Response
application/json
{
  "metadata": {
    "command": "addzonerecord",
    "reason": "Bind reloading on hostname using rndc zone: [example.com]\n",
    "result": 1,
    "version": 1
  }
}

Create domain alias

Request

This function creates an alias (parks a domain on a web virtual host).

Security
BasicAuth
Query
domainstring(domain)required

The domain name to park.

Example: domain=park.example.com
usernamestringrequired

The cPanel user account.

Example: username=username
web_vhost_domainstringrequired

An existing web virtual host to which the new domain name should be added.

Note:

If this is not the cPanel account’s main domain, then the system will consider the new domain to be an addon domain.

Example: web_vhost_domain=vhost.example.com
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_parked_domain_for_user?domain=park.example.com&username=username&web_vhost_domain=vhost.example.com'

Responses

HTTP Request was successful.

Bodyapplication/json
metadataobject
Response
application/json
{
  "metadata": {
    "command": "create_parked_domain_for_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Create subdomain

Request

This function creates a subdomain.

Security
BasicAuth
Query
document_rootstringrequired

The subdomain's document root within the home directory.

Note:

  • An invalid document root path will cause this function to fail.
  • If the Restrict document roots to public_html value is set to On in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings), this parameter must begin with the public_html/ path. For more information, read the cpanel.config file documentation.
Example: document_root=public_html/directory_name
domainstring(domain)required

The subdomain name to create.

Example: domain=subdomain.example.com
use_canonical_nameinteger

Whether to use a canonical name in the Apache® configuration for self-referential URLs.

  • 1 — Use the canonical name.
  • 0 — Do not use the canonical name.
Default 0
Enum01
Example: use_canonical_name=0
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_subdomain?document_root=public_html%2Fdirectory_name&domain=subdomain.example.com&use_canonical_name=0'

Responses

HTTP Request was successful.

Bodyapplication/json
dataobject
metadataobject
Response
application/json
{
  "data": {
    "username": "example"
  },
  "metadata": {
    "command": "create_subdomain",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Domain Management

DNS / Domain Management

Operations

Create DNS zone record

Request

This function adds a DNS zone record.

Important:

  • When you call this function, you must include the additional parameters for the selected zone record type.
  • When you disable the DNS role, the system disables this function.

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
Security
BasicAuth
Bodyapplication/x-www-form-urlencoded
classstringrequired

The record's class.

Example: "IN"
One of:

The record's class.

string

The record's class.

Value"IN"
domainstring(domain)required

The new zone record's domain.

Example: "example.com"
namestring(domain)required

The record's name.

Note:

Do not omit any necessary trailing periods.

You cannot use this function to add temporary domains.

Example: "hostname.example.com."
ttlinteger>= 1

The record's Time To Live (TTL), in seconds.

Default 86400
Example: 86400
typestringrequired

The DNS record type:

  • A - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.
  • A6 - A6 records store IPv6 addresses.
  • AAAA - AAAA records store IPv6 addresses.
  • AFSDB - AFSDB records store the location of an AFS cell's database servers.
  • ALIAS - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.
  • CAA - CAA records control which certificate authorities can issue SSL certificates for a domain.
  • CNAME - CNAME records create an alias to another hostname.
  • DNAME - DNAME records create an alias for a hostname and its subnames.
  • DS - DS records specify a record's delegation signer.
  • HINFO - HINFO records specify a host's CPU and OS types.
  • LOC - LOC records store a hostname's geographical location.
  • MX - MX records point a domain name to its MTAs.
  • NS - NS records store a domain's authoritative nameservers.
  • PTR - PTR records point to a CNAME.
  • RP - RP records store a domain's Responsible Person's information.
  • SOA - SOA records designate the beginning of a zone of authority.
  • SRV - SRV records store the service location records for newer protocols (for example, Autodiscover).
  • TXT - TXT records store descriptive text or useful records (for example, SPF or DKIM records).

When you call this function, you must include the additional parameters for the desired zone record type. Select a zone record from the menu to view the required additional parameters:

Enum"A""A6""AAAA""AFSDB""ALIAS""CAA""CNAME""DNAME""DS""HINFO"
Example: "A"
Discriminator
addressstring(ipv4)

The zone record's IPv4 address.

Note:

For more information about A records, read RFC 1035 at IANA.

Example: "192.168.0.20"
curl -i -X POST \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/whm.openapi/addzonerecord \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d class=IN \
  -d domain=example.com \
  -d name=hostname.example.com. \
  -d ttl=86400 \
  -d type=A \
  -d address=192.168.0.20

Responses

HTTP Request was successful.

Bodyapplication/json
metadataobject
Response
application/json
{
  "metadata": {
    "command": "addzonerecord",
    "reason": "Bind reloading on hostname using rndc zone: [example.com]\n",
    "result": 1,
    "version": 1
  }
}

Create domain alias

Request

This function creates an alias (parks a domain on a web virtual host).

Security
BasicAuth
Query
domainstring(domain)required

The domain name to park.

Example: domain=park.example.com
usernamestringrequired

The cPanel user account.

Example: username=username
web_vhost_domainstringrequired

An existing web virtual host to which the new domain name should be added.

Note:

If this is not the cPanel account’s main domain, then the system will consider the new domain to be an addon domain.

Example: web_vhost_domain=vhost.example.com
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_parked_domain_for_user?domain=park.example.com&username=username&web_vhost_domain=vhost.example.com'

Responses

HTTP Request was successful.

Bodyapplication/json
metadataobject
Response
application/json
{
  "metadata": {
    "command": "create_parked_domain_for_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Create subdomain

Request

This function creates a subdomain.

Security
BasicAuth
Query
document_rootstringrequired

The subdomain's document root within the home directory.

Note:

  • An invalid document root path will cause this function to fail.
  • If the Restrict document roots to public_html value is set to On in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings), this parameter must begin with the public_html/ path. For more information, read the cpanel.config file documentation.
Example: document_root=public_html/directory_name
domainstring(domain)required

The subdomain name to create.

Example: domain=subdomain.example.com
use_canonical_nameinteger

Whether to use a canonical name in the Apache® configuration for self-referential URLs.

  • 1 — Use the canonical name.
  • 0 — Do not use the canonical name.
Default 0
Enum01
Example: use_canonical_name=0
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_subdomain?document_root=public_html%2Fdirectory_name&domain=subdomain.example.com&use_canonical_name=0'

Responses

HTTP Request was successful.

Bodyapplication/json
dataobject
metadataobject
Response
application/json
{
  "data": {
    "username": "example"
  },
  "metadata": {
    "command": "create_subdomain",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Resolvers

DNS / Resolvers

Operations

Service Records

DNS / Service Records

Operations

Feature Access

Hosting Plans / Feature Access

Operations

Feature Lists

Hosting Plans / Feature Lists

Operations

Hosting Plan Extensions

Hosting Plans / Hosting Plan Extensions

Operations

Hosting Plans

Hosting Plans / Hosting Plans

Operations

InProductSurvey

In-product survey information.

Operations

API Authentication

Integrations / API Authentication

Operations

Scripts Hooks

Integrations / Scripts Hooks

Operations

IPv4 Address Settings

IP Address Management / IPv4 Address Settings

Operations

IPv6 Address Settings

IP Address Management / IPv6 Address Settings

Operations

Network Address Translation

IP Address Management / Network Address Translation

Operations

Management

Login Security (cPHulk) / Management

Operations

Reporting

Login Security (cPHulk) / Reporting

Operations

Settings

Login Security (cPHulk) / Settings

Operations

cPanel Account Mail Management

Mail / cPanel Account Mail Management

Operations

Mail DNS Settings

Mail / Mail DNS Settings

Operations

Mail Server Settings

Mail / Mail Server Settings

Operations

Spam Management

Mail / Spam Management

Operations

Spam Protection (Greylisting)

Mail / Spam Protection (Greylisting)

Operations

NGINX Manager

The NGINX Manager module for WHM API 1.

Operations

Account Enhancement Limit

Resellers / Account Enhancement Limit

Operations

Account Limits

Resellers / Account Limits

Operations

Account Permissions

Resellers / Account Permissions

Operations

Account Settings

Resellers / Account Settings

Operations

Reseller Account Management

Resellers / Account Management

Operations

WHM Access

Security / WHM Access

Operations

Configuration Clusters

Server Administration / Configuration Clusters

Operations

Configurations

Server Administration / Configurations

Operations

Connected Applications

Server Administration / Connected Applications

Operations

Connections

Server Administration / Connections

Operations

cPanel Analytics

The cPanel Analytics module for WHM API 1.

Operations

License Management

The Server Administration module for WHM API 1.

Operations

Notifications

Server Administration / Notifications

Operations

Plugin-Based Features

The plugin-based features module for WHM API 1.

Operations

Security

The Security module for WHM API 1.

Operations

Server Nodes

Server Administration / Server Nodes

Operations

Server Profiles

Server Administration / Server Profiles

Operations

Services

Server Administration / Services

Operations

System Information

The Server Administration module for WHM API 1.

Operations

Updates

Server Administration / Updates

Operations

Auto-Generated Certificates

SSL Certificates / Auto-Generated Certificates

Operations

cPanel Account Settings

SSL Certificates / cPanel Account Settings

Operations

SSL Server Settings

SSL Certificates / SSL Server Settings

Operations

Install or Uninstall Package

System Package Management / Install or Uninstall Package

Operations

List Package Information

System Package Management / List Package Information

Operations

Package Manager Settings

System Package Management / Package Manager Settings

Operations

cPanel Account Transfer

Transfers / cPanel Account Transfer

Operations

Transfer Configuration

Transfers / Transfer Configuration

Operations

Transfer Monitoring

Transfers / Transfer Monitoring

Operations

UserData

Scoped userdata storage functions.

Operations

EasyApache Settings

Web Server Configuration / EasyApache Settings

Operations

PHP

The PHP module for WHM API 1.

Operations

PHP-FPM

Web Server Configuration / PHP-FPM

Operations

Rule Settings

Web Server Security (ModSecurity) / Rule Settings

Operations

Rule Vendor Settings

Web Server Security (ModSecurity) / Rule Vendor Settings

Operations

Server Settings

Web Server Security (ModSecurity) / Server Settings

Operations