Skip to content
ConstellaWP Docs

cPanel

A cPanel API token is scoped to one cPanel account (usually one site). ConstellaWP uses UAPI over HTTPS. The connector is read-only: it does not create cPanel full backups. WordPress backups stay on BYOS.

Prerequisites

Section titled “Prerequisites”
  • cPanel login that can create API Tokens
  • The cPanel hostname (and custom port if not 2083)
  • ConstellaWP owner or admin

Steps

Section titled “Steps”

  1. In cPanel, open Security → Manage API Tokens (wording varies by skin) and create a token. Copy it once.

    cPanel: create an API token

  2. Note the hostname you use for cPanel (for example cpanel.example.com) and the cPanel username.

  3. In ConstellaWP, connect cPanel from Hosting or from the site Settings → Hosting connector:

    • Host: hostname only. ConstellaWP adds https:// and port 2083 unless you append a port (cpanel.example.com:2096 for a custom port).
    • Username: cPanel username
    • API Token: the token from step 1
    • Save. ConstellaWP calls UAPI Variables/get_user_information to verify.

  4. Link the site if you added the account from the organization Hosting page. The remote id is the cPanel username.

Field mapping

Section titled “Field mapping”
ConstellaWP field Where to find it in cPanel
Host cPanel hostname, without https://. Default port 2083 is added automatically
Username cPanel account username (not your email, unless they are the same)
API Token Manage API Tokens in cPanel

What you get after linking

Section titled “What you get after linking”
  • Server info — PHP version, disk usage/limit, inodes, main domain, document root (shown on the site Hosting tab)
  • List backups — cPanel-created backups, newest first, information only

To create or restore a cPanel backup, use the cPanel UI. ConstellaWP will not trigger FullBackup.

Common errors

Section titled “Common errors”
Error Likely cause
Connection failed / TLS error Wrong host, expired SSL on the cPanel service, or a firewall blocking port 2083 from ConstellaWP
Authentication failed Username/token mismatch, or the token was revoked
Timeout Host appended incorrectly (do not include https:// or /cpsess… paths)
Empty server info Site is not linked, or UAPI is disabled on that host