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 certificates, and DNS zones for a single cPanel user. UAPI is the recommended replacement for the legacy cPanel API 2.

API entry from apis.yml

apis.yml Raw ↑
aid: cpanel:uapi
name: cPanel UAPI
description: 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 certificates, and DNS
  zones for a single cPanel user. UAPI is the recommended replacement for the legacy cPanel API 2.
image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://api.docs.cpanel.net/cpanel/introduction/
baseURL: https://hostname:2083/execute
tags:
- Databases
- Email
- Files
- Hosting
- REST
- UAPI
properties:
- type: Documentation
  url: https://api.docs.cpanel.net/cpanel/introduction/
- type: GuideToUAPI
  url: https://api.docs.cpanel.net/guides/guide-to-uapi/
- type: AllUAPIFunctions
  url: https://api.docs.cpanel.net/openapi/cpanel/tag/Email/
- type: Authentication
  url: https://api.docs.cpanel.net/guides/guide-to-api-authentication/
features:
- name: Token Authentication
  description: API tokens scoped per cPanel user.
- name: Modular Function Catalog
  description: Functions grouped into modules such as Email, DNS, Mysql, and Ftp.
- name: JSON Responses
  description: Modern JSON responses with consistent metadata envelope.