cPanel

cPanel is a web-based control panel that provides a graphical interface and automation tools to simplify the management of web hosting services. cPanel exposes a family of HTTP APIs (UAPI, WHM API 1, and the legacy cPanel API 2) for automating account, domain, email, database, DNS, and server-wide operations. APIs accept API tokens or Basic Authentication and return JSON or XML responses.

3 APIs 0 Features

Control PanelDNSDomainsEmailHostingResellerServer AdministrationWeb HostingWHM

APIs

cPanel UAPI

The cPanel User API (UAPI) is the modern HTTP API for performing cPanel-level operations such as managing email accounts, mailboxes, files, databases, FTP accounts, SSL certific...

WHM API 1

The WHM API 1 is the HTTP API for server-wide and reseller-level operations including creating, suspending, and terminating cPanel accounts, managing packages and feature lists,...

cPanel API 2 (Legacy)

cPanel API 2 is the legacy XML/JSON API for cPanel-user operations. It remains supported for backward compatibility but has been largely superseded by UAPI; new development shou...

Collections

cPanel UAPI

OPEN

Pricing Plans

Cpanel Plans Pricing

3 plans

PLANS

Rate Limits

Cpanel Rate Limits

5 limits

RATE LIMITS

FinOps

Cpanel Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: cPanel UAPI
  version: '1'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: UAPI
    type: folder
  items:
  - info:
      name: Execute any UAPI function
      type: http
    http:
      method: GET
      url: https://{hostname}:2083/execute/:Module/:Function
      params:
      - name: Module
        value: ''
        type: path
        description: The UAPI module name (e.g. `Email`, `Mysql`, `DomainInfo`).
      - name: Function
        value: ''
        type: path
        description: The function within the module (e.g. `add_pop`, `list_databases`).
    docs: 'Generic UAPI entry point. Pass module-specific parameters as query

      string values.

      '
- info:
    name: Email
    type: folder
  items:
  - info:
      name: Create an email account
      type: http
    http:
      method: GET
      url: https://{hostname}:2083/execute/Email/add_pop
      params:
      - name: domain
        value: ''
        type: query
      - name: email
        value: ''
        type: query
      - name: password
        value: ''
        type: query
      - name: quota
        value: ''
        type: query
    docs: Create an email account
  - info:
      name: List email accounts
      type: http
    http:
      method: GET
      url: https://{hostname}:2083/execute/Email/list_pops
    docs: List email accounts
- info:
    name: Mysql
    type: folder
  items:
  - info:
      name: List MySQL databases
      type: http
    http:
      method: GET
      url: https://{hostname}:2083/execute/Mysql/list_databases
    docs: List MySQL databases
- info:
    name: DomainInfo
    type: folder
  items:
  - info:
      name: List domains on the account
      type: http
    http:
      method: GET
      url: https://{hostname}:2083/execute/DomainInfo/list_domains
    docs: List domains on the account
bundled: true