Skip to content
cPanel UAPI
/
Contact Information

cPanel UAPI (11.134.0.5)

UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.

https://cpanel.net/developers/
Download OpenAPI description
cpanel.openapi.json
cpanel.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/cpanel.openapi/

A server running cPanel.

https://{host}:{port}/execute/

API Token Management

API Development Tools / API Token Management

Operations

Batch

The Batch module for UAPI.

Operations

SSE Task Management

API Development Tools / SSE Task Management

Operations

URL Parsing

API Development Tools / URL Parsing

Operations

External Authentication

Authentication / External Authentication

Operations

Two-Factor Settings

Authentication / Two-Factor Settings

Operations

Block IP

Block Ip Addresses / Block IP

Operations

Market Integration

Commerce Integration / Market Integration

Operations

SSL Certificates

Commerce Integration / SSL Certificates

Operations

Contact Information

cPanel Account / Contact Information

Operations

Return the account's notification preferences.

Request

Use this function to get a cPanel or Webmail account's notification preferences.

Security
BasicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/get_notification_preferences

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "get_notification_preferences"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "get_notification_preferences",
  "module": "ContactInformation",
  "result": {
    "data": [ … ],
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

Return Pushbullet access token

Request

This function retrieves the cPanel account's Pushbullet™ access token.

Security
BasicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/get_pushbullet_access_token

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "get_pushbullet_access_token"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "get_pushbullet_access_token",
  "module": "ContactInformation",
  "result": {
    "data": "a1b2c3d4e5f6g7h8i9j0",
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

Set contact email address(es)

Request

Use this function to set an account's contact email address(es).

To unset all contact email addresses, call unset_email_addresses.

Security
BasicAuth
Query
addressArray of strings(email)required

The account’s new contact email addresses.

Example: address=foo@example.com&address=bar@example.com
old_addressArray of strings(email)required

The account’s existing contact email addresses.

If this list does not match the account’s current current email address(es), then the request will fail. This control is here to prevent race conditions.

Example: old_address=old1@example.com
passwordstringrequired

The account’s password.

Example: password=q1df%D9<z0ShqdxRP%^
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/set_email_addresses?address=foo%40example.com%2Cbar%40example.com&old_address=old1%40example.com&password=q1df%25D9%3Cz0ShqdxRP%25%5E'

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "set_email_addresses"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "set_email_addresses",
  "module": "ContactInformation",
  "result": {
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

Account Enhancements

The Account Enhancement module for UAPI.

Operations

Account Information

cPanel Account / Account Information

Operations

Account Management

cPanel Account / Account Management

Operations

Contact Information

cPanel Account / Contact Information

Operations

Return the account's notification preferences.

Request

Use this function to get a cPanel or Webmail account's notification preferences.

Security
BasicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/get_notification_preferences

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "get_notification_preferences"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "get_notification_preferences",
  "module": "ContactInformation",
  "result": {
    "data": [ … ],
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

Return Pushbullet access token

Request

This function retrieves the cPanel account's Pushbullet™ access token.

Security
BasicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/get_pushbullet_access_token

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "get_pushbullet_access_token"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "get_pushbullet_access_token",
  "module": "ContactInformation",
  "result": {
    "data": "a1b2c3d4e5f6g7h8i9j0",
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

Set contact email address(es)

Request

Use this function to set an account's contact email address(es).

To unset all contact email addresses, call unset_email_addresses.

Security
BasicAuth
Query
addressArray of strings(email)required

The account’s new contact email addresses.

Example: address=foo@example.com&address=bar@example.com
old_addressArray of strings(email)required

The account’s existing contact email addresses.

If this list does not match the account’s current current email address(es), then the request will fail. This control is here to prevent race conditions.

Example: old_address=old1@example.com
passwordstringrequired

The account’s password.

Example: password=q1df%D9<z0ShqdxRP%^
curl -i -X GET \
  -u <username>:<password> \
  'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ContactInformation/set_email_addresses?address=foo%40example.com%2Cbar%40example.com&old_address=old1%40example.com&password=q1df%25D9%3Cz0ShqdxRP%25%5E'

Responses

Request was successful.

Bodyapplication/json
apiversioninteger

The version of the API.

Example: 3
funcstring

The name of the method called.

Example: "set_email_addresses"
modulestring

The name of the module called.

Example: "ContactInformation"
resultobject
Response
application/json
{
  "apiversion": 3,
  "func": "set_email_addresses",
  "module": "ContactInformation",
  "result": {
    "errors": null,
    "messages": null,
    "status": 1,
    "warnings": null
  }
}

cPanel Features

cPanel Account / cPanel Features

Operations

Disk Quotas

cPanel Account / Disk Quotas

Operations

Personalization

The Personalization module for UAPI.

Operations

Resource Usage and Statistics

cPanel Account / Resource Usage and Statistics

Operations

Subaccount Management

cPanel Account / Subaccount Management

Operations

Team Roles

The Team Roles module for UAPI.

Operations

Team Users

The Team User module for UAPI.

Operations

Backup

The Backup module for UAPI.

Operations

File Restoration

cPanel Account Backups / File Restoration

Operations

Plugins

The Plugins module for UAPI.

Operations

Application Information

cPanel Theme Management / Application Information

Operations

Brand Management

cPanel Theme Management / Brand Management

Operations

Browser Cache Management

cPanel Theme Management / Browser Cache Management

Operations

Language

cPanel Theme Management / Language

Operations

Theme Settings

cPanel Theme Management / Theme Settings

Operations

Directory Indexes

Directory Management / Directory Indexes

Operations

Directory Privacy

Directory Management / Directory Privacy

Operations

Directory Protection

Directory Management / Directory Protection

Operations

DNS

The DNS module for UAPI.

Operations

DNS Information

DNS / DNS Information

Operations

DNS Security

DNS / DNS Security

Operations

Dynamic DNS

DNS / Dynamic DNS

Operations

Email DNS Settings

DNS / Email DNS Settings

Operations

Domain

The Domain module for UAPI.

Operations

Domain

The Domain module for UAPI.

Operations

Domain Information

Domain Management / Domain Information

Operations

Domain Redirection

Domain Management / Domain Redirection

Operations

SubDomain

The SubDomain module for UAPI.

Operations

Virtual Host Information

Domain Management / Virtual Host Information

Operations

Email Accounts

Email / Email Accounts

Operations

Email Filtering

Email / Email Filtering

Operations

Email Forwarding

Email / Email Forwarding

Operations

Email Server Information

Email / Email Server Information.

Operations

Email Suspensions

Email / Email Suspensions

Operations

Mail Server Information

Email / Mail Server Information

Operations

Mailbox Management

Email / Mailbox Management

Operations

Mailing Lists

Email / Mailing Lists

Operations

Signing and Encryption (GnuPG Keys)

Email / Signing and Encryption (GnuPG Keys)

Operations

Spam Filtering (Greylisting)

Email / Spam Filtering (Greylisting)

Operations

Spam Management

Email / Spam Management

Operations

Spam Prevention (BoxTrapper)

Email / Spam Prevention (BoxTrapper)

Operations

Webmail Applications

Email / Webmail Applications

Operations

Webmail Sessions

Email / Webmail Sessions

Operations

FTP Accounts

Files / FTP Accounts

Operations

FTP Server Settings

Files / FTP Server Settings

Operations

Image Tools

Files / Image Tools

Operations

Manage Files

Files / Manage Files

Operations

WebDisk Settings

Files / WebDisk Settings

Operations

Deployment Settings

GIT Management / Deployment Settings

Operations

Repository Management

GIT Management / Repository Management

Operations

InProductSurvey

The InProductSurvey module for cPanel UAPI.

Operations

Database Information

MySQL and MariaDB / Database Information

Operations

Database Management

MySQL and MariaDB / Database Management

Operations

Remote Databases

MySQL and MariaDB / Remote Databases

Operations

User Management

MySQL and MariaDB / User Management

Operations

Pushbullet

The Pushbullet module for UAPI.

Operations

Antivirus Protection (ClamAV)

Optional Applications / Antivirus Protection (ClamAV)

Operations

Calendar and Contacts (DAV)

Optional Applications / Calendar and Contacts (DAV)

Operations

Calendar and Contacts Server

Optional Applications / Calendar and Contacts Server

Operations

cPanel Addons (cPAddons)

Optional Applications / cPanel Addons (cPAddons)

Operations

WordPress Manager Backups

Optional Applications / WordPress Manager Backups

Operations

WordPress Manager Settings

Optional Applications / WordPress Manager Settings

Operations

PostgreSQL Database Management

PostgreSQL / Database Management

Operations

PostgreSQL User Management

PostgreSQL / User Management

Operations

Bandwidth

The Bandwidth module for UAPI.

Operations

Known SSH Hosts Management

Security / Known SSH Hosts Management

Operations

Login Information

Security / Login Information

Operations

cPanel Server Information

Server Information / cPanel Server Information

Operations

Notifications

The Notifications module for UAPI.

Operations

Password Strength

Server Information / Password Strength

Operations

SSH

The SSH module for UAPI.

Operations

ServiceProxy

The ServiceProxy module for UAPI.

Operations

SiteQuality

The SiteQuality module for UAPI.

Operations

Auto-generated SSL Certificates

SSL Certificates / Auto-generated SSL Certificates

Operations

cPanel Account SSL Management

SSL Certificates / cPanel Account SSL Management

Operations

SNI Email Settings

SSL Certificates / SNI Email Settings

Operations

SSL Certificate Management

SSL Certificates / SSL Certificate Management

Operations

Verify Domain Ownership

SSL Certificates / Verify Domain Ownership

Operations

Domain Statistics

Statistics / Domain Statistics

Operations

Weblog Settings

Statistics / Weblog Settings

Operations

UserData

The UserData module for cPanel UAPI.

Operations

EA4

The EA4 module for UAPI.

Operations

PHP

PHP recommendations

Operations

Application Manager

Web Server Management / Application Manager

Operations

ModSecurity

The ModSecurity module for UAPI.

Operations

NginxCaching

The NginxCaching module for UAPI.

Operations

PHP Settings

Web Server Management / PHP Settings

Operations

Handler Management

Website Configuration / Handler Management

Operations

Logs

Website Configuration / Logs

Operations

Mime Type Management

Website Configuration / Mime Type Management

Operations

Site Information

Website Configuration / Site Information

Operations

Site Installation

Website Configuration / Site Installation

Operations

Site Publisher Management

Website Configuration / Site Publisher Management

Operations

Sitejet

The Sitejet module for UAPI.

Operations