cPanel UAPI
The cPanel User API (UAPI) is the modern HTTP API for cPanel-account operations — email accounts, mailboxes, files, MySQL and PostgreSQL databases, FTP accounts, SSL certificates, DNS, backups and more — for a single cPanel user. 657 operations across 101 modules, served at /execute/{Module}/{Function} on the customer's own cPanel server (port 2083 secure, 2082 unsecure, 2096/2095 for Webmail sessions). Authenticates with HTTP Basic or an 'Authorization: cpanel :' API token. Every call returns HTTP 200; success is result.status == 1. UAPI is the recommended replacement for the legacy cPanel API 2.
cPanel UAPI is one of 4 APIs that cPanel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Databases, Email, File, Hosting, and REST. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 657 operations across 657 paths, organized into 104 resource areas, and defines 42 schemas. It is described by OpenAPI 3.0.2, at version 11.137.9999.106.
Requests are made against a single base URL, https://{host}:{port}/execute.
657 operations
657 paths
42 schemas
636 GET21 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
cPanel UAPI declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 657
Across 657 paths, the API surfaces 657 operations — 636 GET, 21 POST. They span 104 resource areas, including Account Enhancements, AddonDomain, Backup, File Restoration, BackupInfo, Bandwidth, Batch, BlockIP, and 96 more. Each is listed below with its method, path, parameters, and response codes.
Account Enhancements 2
The Account Enhancement module for UAPI.
GET
/AccountEnhancements/has_enhancement
Validate Account Enhancement assignment
GET
/AccountEnhancements/list
Return all cPanel account's Account Enhancements
AddonDomain 3
The AddonDomain module for UAPI.
GET
/AddonDomain/addaddondomain
Create an addon domain
GET
/AddonDomain/deladdondomain
Remove an addon domain
GET
/AddonDomain/listaddondomains
List the addon domains
Backup 5
The Backup module for UAPI.
GET
/Backup/fullbackup_to_ftp
Back up cPanel account via FTP
GET
/Backup/fullbackup_to_homedir
Back up cPanel account to home directory
GET
/Backup/fullbackup_to_scp_with_key
Back up cPanel account via SCP with SSH key
GET
/Backup/fullbackup_to_scp_with_password
Back up cPanel account via SCP with password
GET
/Backup/list_backups
Return backup files
File Restoration 8
cPanel Account Backups / File Restoration
POST
/Backup/restore_databases
Restore databases
POST
/Backup/restore_email_filters
Restore email filters
POST
/Backup/restore_email_forwarders
Restore email forwarders
POST
/Backup/restore_files
Restore files
GET
/Restore/directory_listing
Return backups in home directory
GET
/Restore/get_users
Return cPanel accounts with backup metadata
GET
/Restore/query_file_info
Return backup storage locations
GET
/Restore/restore_file
Restore file or directory
BackupInfo 3
The BackupInfo module for UAPI.
GET
/BackupInfo/list
List the current user's full-account backups
GET
/BackupInfo/progress
Get progress for the current user's running full-account backup
GET
/BackupInfo/reset
Clear the current user's backup run-state record
Bandwidth 3
The Bandwidth module for UAPI.
GET
/Bandwidth/get_enabled_protocols
Return services monitored in bandwidth data
GET
/Bandwidth/get_retention_periods
Return bandwidth retention period
GET
/Bandwidth/query
Return cPanel account's bandwidth usage report
Batch 1
The Batch module for UAPI.
GET
/Batch/strict
Run multiple UAPI functions in order
BlockIP 2
The BlockIP module for UAPI.
GET
/BlockIP/add_ip
Add IP address to cPanel account's block list
GET
/BlockIP/remove_ip
Remove IP address from cPanel account's block list
BoxTrapper 25
The BoxTrapper module for UAPI.
GET
/BoxTrapper/blacklist_messages
Add email address to BoxTrapper blocked senders
GET
/BoxTrapper/delete_messages
Delete messages in the BoxTrapper queue
GET
/BoxTrapper/deliver_messages
Send messages in the BoxTrapper queue
GET
/BoxTrapper/get_allowlist
Return account BoxTrapper allowlist rules
GET
/BoxTrapper/get_blocklist
Return account BoxTrapper blocklist rules
GET
/BoxTrapper/get_configuration
Return email account's BoxTrapper configuration
GET
/BoxTrapper/get_email_template
Return specified BoxTrapper email template
GET
/BoxTrapper/get_forwarders
Return all BoxTrapper forwarders
GET
/BoxTrapper/get_ignorelist
Return account BoxTrapper ignorelist rules
GET
/BoxTrapper/get_log
Return BoxTrapper log file and contents
GET
/BoxTrapper/get_message
Return message's top 200 lines in BoxTrapper queue
GET
/BoxTrapper/get_status
Return whether email account uses BoxTrapper
GET
/BoxTrapper/ignore_messages
Add email account to Exim ignore list
GET
/BoxTrapper/list_email_templates
Return BoxTrapper email templates
GET
/BoxTrapper/list_queued_messages
Return email account's BoxTrapper queued messages
GET
/BoxTrapper/process_messages
Run a specific BoxTrapper action for a message
GET
/BoxTrapper/reset_email_template
Restore default BoxTrapper email message template
GET
/BoxTrapper/save_configuration
Update email account's BoxTrapper configuration
GET
/BoxTrapper/save_email_template
Save BoxTrapper message template contents
GET
/BoxTrapper/set_allowlist
Update account BoxTrapper allowlist
GET
/BoxTrapper/set_blocklist
Update account BoxTrapper blocklist
GET
/BoxTrapper/set_forwarders
Add email address to BoxTrapper forwarders
GET
/BoxTrapper/set_ignorelist
Update account BoxTrapper ignorelist
GET
/BoxTrapper/set_status
Enable or disable BoxTrapper for email account
GET
/BoxTrapper/whitelist_messages
Add email address to BoxTrapper allowed senders
Branding 5
The Branding module for UAPI.
GET
/Branding/get_application_information
Return single app's info from dynamicui.conf
GET
/Branding/get_applications
Return multiple apps' info from dynamicui.conf
GET
/Branding/get_available_applications
Return current user's cPanel application details
GET
/Branding/get_information_for_applications
Return app's info from sitemap.json
GET
/Branding/include
Return branding file content from the active theme
CCS 5
The CCS module for UAPI.
GET
/CCS/add_delegate
Add calendar delegation
GET
/CCS/list_delegates
List cPanel account's calendar delegates
GET
/CCS/list_users
List cPanel account's calendar users
GET
/CCS/remove_delegate
Remove calendar delegation
GET
/CCS/update_delegate
Update calendar delegation
DAV 12
The DAV module for UAPI.
GET
/CPDAVD/add_delegate
Share a calendar
GET
/CPDAVD/list_delegates
List calendar sharing.
GET
/CPDAVD/list_users
List CalDAV and CardDAV users
GET
/CPDAVD/manage_collection
Manage a calendar, task list, or address book
GET
/CPDAVD/remove_delegate
Remove a share.
GET
/CPDAVD/update_delegate
Update calendar sharing.
GET
/DAV/disable_shared_global_addressbook
Disable global address book
GET
/DAV/enable_shared_global_addressbook
Enable global address book
GET
/DAV/get_calendar_contacts_config
Return CalDAV and CardDAV connection information
GET
/DAV/has_shared_global_addressbook
Return whether global address book is enabled
GET
/DAV/is_dav_service_enabled
Return whether DAV is enabled
GET
/DAV/is_horde_enabled
Return whether Horde is enabled
CSVImport 1
The CSVImport module for UAPI.
GET
/CSVImport/doimport
Import email accounts from CSV file
CacheBuster 2
The CacheBuster module for UAPI.
GET
/CacheBuster/read
Return web browser cached file override ID
GET
/CacheBuster/update
Create web browser cached file override ID
Chkservd 2
The Chkservd module for UAPI.
GET
/Chkservd/get_exim_ports
Return outgoing (SMTP) mail port
GET
/Chkservd/get_exim_ports_ssl
Return outgoing mail (SMTP) SSL-secured port
Chrome 1
The Chrome module for UAPI.
GET
/Chrome/get_dom
Return cPanel theme header and footer HTML
ClamScanner 6
The ClamScanner module provides methods for ClamAV® virus scans and disinfection.
GET
/ClamScanner/check_disinfection_status
Request disinfection process status
POST
/ClamScanner/disinfect_files
Start disinfecting files with viruses
GET
/ClamScanner/get_scan_paths
Return virus scan types
GET
/ClamScanner/get_scan_status
Request virus scan status
GET
/ClamScanner/list_infected_files
Return infected file list
GET
/ClamScanner/start_scan
Start virus scan
ContactInformation 6
The ContactInformation module for UAPI.
GET
/ContactInformation/get_notification_preferences
Return the account's notification preferences.
GET
/ContactInformation/get_pushbullet_access_token
Return Pushbullet access token
GET
/ContactInformation/set_email_addresses
Set contact email address(es)
POST
/ContactInformation/set_notification_preferences
Set the account's notification preferences.
GET
/ContactInformation/set_pushbullet_access_token
Update Pushbullet access token
GET
/ContactInformation/unset_email_addresses
Unset contact email addresses
Contactus 1
The Contactus module for UAPI.
GET
/Contactus/is_enabled
Return whether contact option is enabled
DCV 3
The DCV module for UAPI.
POST
/DCV/check_domains_via_dns
Verify domain ownership via DNS
GET
/DCV/check_domains_via_http
Verify domain ownership via HTTP
GET
/DCV/ensure_domains_can_pass_dcvdeprecated
Verify domain ownership
DNS 10
The DNS module for UAPI.
GET
/DNS/ensure_domains_reside_only_locally
Return whether domains only resolve locally
GET
/DNS/fetch_cpanel_generated_domains
Retrieve cPanel-generated subdomains for a domain
GET
/DNS/has_local_authority
Return whether local DNS server is authoritative
GET
/DNS/is_alias_available
Return ALIAS DNS record availability & resolver
GET
/DNS/is_https_available
Return DNS HTTPS record support information
GET
/DNS/is_svcb_available
Return DNS SVCB record support information
GET
/DNS/lookup
Return domain's DNS information
GET
/DNS/mass_edit_zone
Update a DNS zone
GET
/DNS/parse_zone
Return a parsed DNS zone
GET
/DNS/swap_ip_in_zones
Update IP addresses in zone files
DNSSEC 12
The DNSSEC module for UAPI.
GET
/DNSSEC/activate_zone_key
Enable DNSSEC security key
GET
/DNSSEC/add_zone_key
Create DNSSEC security key
GET
/DNSSEC/deactivate_zone_key
Disable DNSSEC security key
GET
/DNSSEC/disable_dnssec
Disable DNSSEC
GET
/DNSSEC/enable_dnssec
Enable DNSSEC
GET
/DNSSEC/export_zone_dnskey
Export DNSKEY record value
GET
/DNSSEC/export_zone_key
Export DNSSEC security key
GET
/DNSSEC/fetch_ds_records
Return domain's DS records
GET
/DNSSEC/import_zone_key
Add DNSSEC security key
GET
/DNSSEC/remove_zone_key
Remove DNSSEC security key
GET
/DNSSEC/set_nsec3
Update domain to use NSEC3
GET
/DNSSEC/unset_nsec3
Update domain to use NSEC
DirectoryIndexes 3
The DirectoryIndexes module for UAPI.
GET
/DirectoryIndexes/get_indexing
Return directory indexing settings
GET
/DirectoryIndexes/list_directories
Return subdirectories directory indexing settings
GET
/DirectoryIndexes/set_indexing
Update directory indexing settings
DirectoryPrivacy 6
The DirectoryPrivacy module for UAPI.
GET
/DirectoryPrivacy/add_user
Add authorized user for protected directory
GET
/DirectoryPrivacy/configure_directory_protection
Enable or disable protected directory
GET
/DirectoryPrivacy/delete_user
Delete authorized user for protected directory
GET
/DirectoryPrivacy/is_directory_protected
Return whether directory uses password protection
GET
/DirectoryPrivacy/list_directories
Return privacy status of subdirectories
GET
/DirectoryPrivacy/list_users
Return authorized users for protected directory
DirectoryProtection 1
The DirectoryProtection module for UAPI.
GET
/DirectoryProtection/list_directories
Return Directory Protection settings
Domain 4
The Domain module for UAPI.
POST
/Domain/convert_temporary_to_registered
Convert a temporary domain to a registered domain
GET
/Domain/is_temporary_domain
Return whether a domain is temporary
POST
/Domain/rename_domain
Rename a primary, addon, or alias domain
GET
/Domain/temporary_domain_is_disabled
Return whether temporary domains are disabled
DomainInfo 5
The DomainInfo module for UAPI.
GET
/DomainInfo/domains_data
Return all domains' hosting configuration
GET
/DomainInfo/list_domains
Return cPanel account's domains
GET
/DomainInfo/main_domain_builtin_subdomain_aliases
Return built-in subdomain aliases
GET
/DomainInfo/primary_domain
Return the cPanel account's primary domain
GET
/DomainInfo/single_domain_data
Return domain's hosting configuration
DomainLookup 4
The DomainLookup module for UAPI.
GET
/DomainLookup/countbasedomains
Count the domains that have their own DNS zone
GET
/DomainLookup/getbasedomains
List the domains that have their own DNS zone
GET
/DomainLookup/getdocroot
Return a domain's document root
GET
/DomainLookup/getdocroots
Return every domain's document root
DomainRecommendations 6
The DomainRecommendations module for UAPI.
GET
/DomainRecommendations/domain_availability
Check whether a domain is available for registration
GET
/DomainRecommendations/domain_suggestions
Search for available domain names and pricing
GET
/DomainRecommendations/get_store_config
Retrieve the sanitized domain store configuration
GET
/DomainRecommendations/is_enabled
Check whether Domain Recommendations is enabled
GET
/DomainRecommendations/purchase_domain
Get a URL to purchase a domain
GET
/DomainRecommendations/supported_tlds
List the TLDs supported by the domain store
DynamicDNS 5
The DynamicDNS module for UAPI.
GET
/DynamicDNS/create
Create Dynamic DNS domain
GET
/DynamicDNS/delete
Delete Dynamic DNS domain
GET
/DynamicDNS/list
Return Dynamic DNS domains
GET
/DynamicDNS/recreate
Update Dynamic DNS domain ID
GET
/DynamicDNS/set_description
Update Dynamic DNS domain description
PHP 1
PHP recommendations
GET
/EA4/get_php_recommendations
Get custom PHP recommendations.
EA4 1
The EA4 module for UAPI.
GET
/EA4/get_recommendations
Get EA4 configuration recommendations
Email 92
The Email module for UAPI.
GET
/Email/account_name
Return current user's account name
GET
/Email/add_auto_responder
Create email account's autoresponder
GET
/Email/add_domain_forwarder
Create domain-level forwarder
GET
/Email/add_forwarder
Create email account forwarder
GET
/Email/add_list
Create mailing list
GET
/Email/add_mailman_delegates
Add administrators to mailing list
GET
/Email/add_pop
Create email account
GET
/Email/add_spam_filter
Update minimum spam score threshold value
GET
/Email/browse_mailbox
Return mail directory's subdirectories and files
GET
/Email/check_fastmail
Return BlackBerry FastMail support status
GET
/Email/count_auto_responders
Return cPanel account's autoresponders total
GET
/Email/count_filters
Return cPanel account's email filters total
GET
/Email/count_forwarders
Return cPanel account's mail forwarder total
GET
/Email/count_lists
Return cPanel account's mailing list total
GET
/Email/count_pops
Return cPanel account's email account total
GET
/Email/delete_auto_responder
Delete email account's autoresponder
GET
/Email/delete_domain_forwarder
Delete domain-level forwarder
GET
/Email/delete_filter
Delete email account's email filter
GET
/Email/delete_forwarder
Delete email account's email forwarder
GET
/Email/delete_held_messages
Delete email account's outgoing messages
GET
/Email/delete_list
Delete mailing list
GET
/Email/delete_pop
Delete email account
GET
/Email/disable_filter
Disable email filter for email account
GET
/Email/disable_mailbox_autocreate
Disable cPanel account mailbox autocreation
GET
/Email/disable_spam_assassin
Disable Apache SpamAssassin for cPanel account
GET
/Email/disable_spam_autodelete
Disable spam box filtering auto-delete
GET
/Email/disable_spam_box
Disable spam box filtering for cPanel account
GET
/Email/dispatch_client_settings
Send email client settings to an email address
GET
/Email/edit_pop_quota
Update email account's quota
GET
/Email/enable_filter
Enable email filter for email account
GET
/Email/enable_mailbox_autocreate
Enable cPanel account mailbox autocreation
GET
/Email/enable_spam_assassin
Enable Apache SpamAssassin for cPanel account
GET
/Email/enable_spam_box
Enable spam box filtering for cPanel account
GET
/Email/export_lists
Export cPanel account's Mailman mailing lists to a file
GET
/Email/fetch_charmaps
Return server's supported character encodings
GET
/Email/fts_rescan_mailbox
Start IMAP Full-Text Search scan for email account
GET
/Email/generate_mailman_otp
Create one-time password for a mailing list
GET
/Email/get_auto_responder
Return email account's autoresponder information
GET
/Email/get_charsets
Return mail server's supported character encodings
GET
/Email/get_client_settings
Return email account's client settings
GET
/Email/get_default_email_quota
Return email account's default email quota
GET
/Email/get_default_email_quota_mib
Return email account's default email quota in MiB
GET
/Email/get_disk_usage
Return email account's disk usage
GET
/Email/get_filter
Return email filter's information
GET
/Email/get_held_message_count
Return email account's outgoing message count
GET
/Email/get_lists_total_disk_usage
Return cPanel account's mailing list disk usage
GET
/Email/get_mailbox_autocreate
Return cPanel account's mailbox autocreate status
GET
/Email/get_mailman_delegates
Return mailing list administrators
GET
/Email/get_main_account_disk_usage
Return primary email account's disk usage
GET
/Email/get_main_account_disk_usage_bytes
Return primary email account's disk usage in bytes
GET
/Email/get_max_email_quota
Return email account's max quota size
GET
/Email/get_max_email_quota_mib
Return email account's max quota size in MiB
GET
/Email/get_pop_quota
Return email account's quota
GET
/Email/get_spam_settings
Return email account Apache SpamAssassin settings
GET
/Email/get_webmail_settings
Return email account's Webmail settings
GET
/Email/has_delegated_mailman_lists
Return email account's mailing list privileges
GET
/Email/has_plaintext_authentication
Return whether plaintext authentication is enabled
GET
/Email/hold_outgoing
Stop email account's outgoing mail
GET
/Email/list_auto_responders
Return domain's autoresponders
GET
/Email/list_default_address
Return domain's default email address
GET
/Email/list_domain_forwarders
Return domain-level forwarders
GET
/Email/list_filters
Return account-level email filters
GET
/Email/list_filters_backups
Return domains with domain-level email filters
GET
/Email/list_forwarders
Return domain's forwarders
GET
/Email/list_forwarders_backups
Return domains with domain-level forwarders
GET
/Email/list_lists
Return cPanel account's mailing lists
GET
/Email/list_mail_domains
Return cPanel account's mail domains
GET
/Email/list_pops
Return email accounts
GET
/Email/list_pops_with_disk
Return email accounts with disk information
GET
/Email/list_system_filter_info
Return system-level email filter file information
GET
/Email/passwd_list
Update mailing list password
GET
/Email/passwd_pop
Update email account password
GET
/Email/release_outgoing
Start email account outgoing mail
GET
/Email/remove_mailman_delegates
Remove account mailing list admin privileges
GET
/Email/reorder_filters
Update email address's email filter order
GET
/Email/set_always_accept
Update Mail Exchanger type
GET
/Email/set_default_address
Create default email address
GET
/Email/set_list_privacy_options
Update mailing list privacy options
GET
/Email/set_manual_mx_redirects
Add manual MX redirection
GET
/Email/stats_db_status
Return eximstats SQLite database status
GET
/Email/store_filter
Create email filter
GET
/Email/suspend_incoming
Suspend email account incoming (SMTP) mail
GET
/Email/suspend_login
Suspend email account login
GET
/Email/suspend_outgoing
Suspend email account outgoing mail
GET
/Email/terminate_mailbox_sessions
Stop cPanel account IMAP and POP3 connections
GET
/Email/trace_delivery
Run email delivery route trace
GET
/Email/trace_filter
Run test for main domain email filters
GET
/Email/unset_manual_mx_redirects
Remove manual MX redirection
GET
/Email/unsuspend_incoming
Unsuspend email account incoming mail
GET
/Email/unsuspend_login
Unsuspend email account login
GET
/Email/unsuspend_outgoing
Unsuspend email account outgoing mail
GET
/Email/verify_password
Validate email account password
Email DNS Settings 4
DNS / Email DNS Settings
GET
/Email/add_mx
Create mail exchanger record
GET
/Email/change_mx
Update mail exchanger record
GET
/Email/delete_mx
Delete mail exchanger record
GET
/Email/list_mxs
Return mail exchanger records
EmailAuth 12
The EmailAuth module for UAPI.
GET
/EmailAuth/apply_dmarc
Apply DMARC records to domains.
GET
/EmailAuth/disable_dkim
Remove domains' DKIM records
GET
/EmailAuth/enable_dkim
Enable domains' DKIM records
GET
/EmailAuth/ensure_dkim_keys_exist
Validate domains' DKIM private keys
GET
/EmailAuth/fetch_dkim_private_keys
Return domains' DKIM private keys
GET
/EmailAuth/install_dkim_private_keys
Add domains' DKIM record keys
GET
/EmailAuth/install_spf_records
Add domains' SPF records
GET
/EmailAuth/remove_dmarc
Remove DMARC record from domain(s)
GET
/EmailAuth/validate_current_dkims
Validate domains' DKIM records
GET
/EmailAuth/validate_current_dmarcs
Validate domains' DMARC records
GET
/EmailAuth/validate_current_ptrs
Validate domains' PTR records
GET
/EmailAuth/validate_current_spfs
Validate domains' SPF records
ExternalAuthentication 5
The ExternalAuthentication module for UAPI.
GET
/ExternalAuthentication/add_authn_link
Add external authentication link
GET
/ExternalAuthentication/configured_modules
Return server's external authentication providers
GET
/ExternalAuthentication/get_authn_links
Return external authentication links
GET
/ExternalAuthentication/has_external_auth_modules_configured
Return external authentication user status
GET
/ExternalAuthentication/remove_authn_link
Remove external authentication link
ExtractInfo 3
The ExtractInfo module for UAPI.
GET
/ExtractInfo/finish
Clear the current user's extract run-state marker
GET
/ExtractInfo/progress
Get progress for the current user's running archive extraction
GET
/ExtractInfo/start
Begin tracking progress for an extract run
Features 5
The Features module for UAPI.
GET
/Features/get_feature_metadata
Return cPanel account's features' metadata
GET
/Features/has_feature
Validate cPanel account's feature access
GET
/Features/has_features_like
Return whether queried features are enabled
GET
/Features/list_features
Return cPanel account's features
GET
/Features/list_features_like
Return queried cPanel account features
Fileman 14
The Fileman module for UAPI.
GET
/Fileman/autocompletedir
Return autocomplete file and directory names
GET
/Fileman/copy_file
Copy a file
GET
/Fileman/delete_file
Delete a file permanently
GET
/Fileman/empty_trash
Delete .trash folder content
GET
/Fileman/get_file_content
Return file content
GET
/Fileman/get_file_information
Return file or directory information
GET
/Fileman/list_files
Return directory content
GET
/Fileman/move_file
Move a file
GET
/Fileman/rename_file
Rename a file
GET
/Fileman/restore_from_trash
Restore a file from the trash
GET
/Fileman/save_file_content
Save file
GET
/Fileman/transcode
Update buffer encoding
GET
/Fileman/trash_file
Move a file to the trash
POST
/Fileman/upload_files
Upload files
Ftp 20
The FTP module for UAPI.
GET
/Ftp/add_ftp
Create FTP account
GET
/Ftp/allows_anonymous_ftp
Return if anonymous FTP connections allowed
GET
/Ftp/allows_anonymous_ftp_incoming
Return if anonymous FTP transfers allowed
GET
/Ftp/delete_ftp
Delete FTP account
GET
/Ftp/ftp_exists
Return whether an FTP account exists
GET
/Ftp/get_ftp_daemon_info
Return FTP server's information
GET
/Ftp/get_port
Return FTP server's port
GET
/Ftp/get_quota
Return FTP account's quota
GET
/Ftp/get_welcome_message
Return FTP account's welcome message
GET
/Ftp/kill_session
Stop FTP session
GET
/Ftp/list_ftp
Return FTP accounts
GET
/Ftp/list_ftp_with_disk
Return FTP accounts and disk usage
GET
/Ftp/list_sessions
Return FTP server's active sessions
GET
/Ftp/passwd
Update FTP account's password
GET
/Ftp/server_name
Return whether server uses ProFTPD or Pure-FTPd
GET
/Ftp/set_anonymous_ftp
Enable or disable anonymous FTP logins
GET
/Ftp/set_anonymous_ftp_incoming
Enable or disable anonymous incoming FTP transfers
GET
/Ftp/set_homedir
Update FTP account's home directory
GET
/Ftp/set_quota
Update FTP account's quota
GET
/Ftp/set_welcome_message
Update FTP welcome message
GPG 7
The GPG module for UAPI.
GET
/GPG/delete_keypair
Delete GnuPG key pair
GET
/GPG/export_public_key
Export GnuPG public key
GET
/GPG/export_secret_key
Export GnuPG secret key
GET
/GPG/generate_key
Create GnuPG key
GET
/GPG/import_key
Import GnuPG key
GET
/GPG/list_public_keys
Return current user's GnuPG public keys
GET
/GPG/list_secret_keys
Return current user's GnuPG secret keys
ImageManager 4
The ImageManager module for UAPI.
GET
/ImageManager/convert_file
Create image with new format
GET
/ImageManager/create_thumbnails
Create image thumbnails
GET
/ImageManager/get_dimensions
Return image dimensions
GET
/ImageManager/resize_image
Save resized image
InProductSurvey 1
The InProductSurvey module for cPanel UAPI.
GET
/InProductSurvey/get_in_product_survey_url
Return in-product survey banner data
Integration 1
The Integration module for UAPI.
GET
/Integration/fetch_url
Return integrated application URL
KnownHosts 4
The KnownHosts module for UAPI.
GET
/KnownHosts/create
Create host
GET
/KnownHosts/delete
Delete host
GET
/KnownHosts/update
Update host in the knownhosts file
GET
/KnownHosts/verify
Validate host
LangPHP 11
The LangPHP module for UAPI.
GET
/LangPHP/php_get_domain_handler
Return PHP version's handler
GET
/LangPHP/php_get_impacted_domains
Return domains that shared PHP configuration
GET
/LangPHP/php_get_installed_versions
Return installed PHP versions
GET
/LangPHP/php_get_system_default_version
Return default PHP version
GET
/LangPHP/php_get_vhost_versions
Return virtual host's PHP version
GET
/LangPHP/php_ini_get_user_basic_directives
Return basic PHP directives
GET
/LangPHP/php_ini_get_user_content
Return virtual host's php.ini content
GET
/LangPHP/php_ini_get_user_paths
Return php.ini file paths
GET
/LangPHP/php_ini_set_user_basic_directives
Update basic PHP directives
GET
/LangPHP/php_ini_set_user_content
Update virtual host's php.ini content
GET
/LangPHP/php_set_vhost_versions
Update virtual host's PHP version
LastLogin 1
The LastLogin module for UAPI.
GET
/LastLogin/get_last_or_current_logged_in_ip
Return last authenticated login IP address
Locale 3
The Locale module for UAPI.
GET
/Locale/get_attributes
Return current locale settings
GET
/Locale/list_locales
Return available locales
GET
/Locale/set_locale
Update cPanel account locale
LogManager 6
The LogManager module for UAPI.
GET
/LogManager/delete_archive
Delete a log archive file
GET
/LogManager/get_settings
Retrieve cPanel account's log archival settings
GET
/LogManager/list_archives
Return cPanel account's archive files list
GET
/LogManager/list_error_logs
Return domain's PHP error logs
GET
/LogManager/set_settings
Save cPanel account's log archive settings
GET
/LogManager/view_error_log
Return PHP error log for a domain
Mailboxes 5
The Mailboxes module for UAPI.
GET
/Mailboxes/expunge_mailbox_messages
Delete selected messages in mailbox
GET
/Mailboxes/expunge_messages_for_mailbox_guid
Delete selected messages in mailbox by GUID
GET
/Mailboxes/get_mailbox_status_list
Return cPanel account's mailbox status
GET
/Mailboxes/has_utf8_mailbox_names
Return if cPanel account's mailboxes use UTF-8
GET
/Mailboxes/set_utf8_mailbox_names
Enable or disable Webmail mailbox UTF-8 encoding
Market 19
The Market module for UAPI.
GET
/Market/cancel_pending_ssl_certificate
Delete an order
GET
/Market/create_shopping_cart
Create shopping cart
GET
/Market/create_shopping_cart_non_ssl
Create shopping cart for non-SSL products
GET
/Market/get_all_products
Return provider's available products
GET
/Market/get_build_cart_url
Build cart URL for a product
GET
/Market/get_certificate_status_details
Return provider's SSL certificate request status
GET
/Market/get_completion_url
Get product purchase completion URL
GET
/Market/get_license_info
Retrieve license information for a domain
GET
/Market/get_login_url
Return provider's login URL
GET
/Market/get_pending_ssl_certificates
Return provider's pending SSL certificates
GET
/Market/get_product_info
Retrieve product information
GET
/Market/get_provider_specific_dcv_constraints
Return provider's DCV filename requirements
GET
/Market/get_providers_list
Return enabled providers
GET
/Market/get_ssl_certificate_if_available
Return provider's available SSL certificates
GET
/Market/process_ssl_pending_queue
Start processing pending queue's SSL certificates
GET
/Market/request_ssl_certificates
Request SSL certificate order
GET
/Market/set_status_of_pending_queue_items
Update status of items in pending queue
GET
/Market/set_url_after_checkout
Update URL after checkout
GET
/Market/validate_login_token
Validate login token
Mime 14
The Mime module for UAPI.
GET
/Mime/add_handler
Add web server MIME type handler
GET
/Mime/add_hotlink
Enable hotlink protection
GET
/Mime/add_mime
Add MIME type to web server
GET
/Mime/add_redirect
Add redirect to domain
GET
/Mime/delete_handler
Remove web server MIME type handler
GET
/Mime/delete_hotlink
Disable hotlink protection
GET
/Mime/delete_mime
Remove MIME type from web server
GET
/Mime/delete_redirect
Remove redirect from domain
GET
/Mime/get_redirect
Return redirect URL for domain
GET
/Mime/list_handlers
Return web server's MIME handlers
GET
/Mime/list_hotlinks
Return domains with hotlink protection
GET
/Mime/list_mime
Return web server's MIME types
GET
/Mime/list_redirects
Return .htaccess files' redirects
GET
/Mime/redirect_info
Return redirect information
ModSecurity 6
The ModSecurity module for UAPI.
GET
/ModSecurity/disable_all_domains
Disable ModSecurity for all domains
GET
/ModSecurity/disable_domains
Disable ModSecurity for selected domains
GET
/ModSecurity/enable_all_domains
Enable ModSecurity for all domains
GET
/ModSecurity/enable_domains
Enable ModSecurity for selected domains
GET
/ModSecurity/has_modsecurity_installed
Return ModSecurity installation status
GET
/ModSecurity/list_domains
Return ModSecurity domains' status
Mysql 25
The Mysql module for UAPI.
GET
/Mysql/add_host
Enable remote MySQL host access
GET
/Mysql/add_host_note
Add remote MySQL host note
GET
/Mysql/check_database
Validate MySQL database integrity
GET
/Mysql/create_database
Create MySQL database
GET
/Mysql/create_user
Create MySQL user
GET
/Mysql/delete_database
Delete MySQL database
GET
/Mysql/delete_host
Disable remote MySQL host access
GET
/Mysql/delete_user
Delete MySQL user
GET
/Mysql/dump_database_schema
Return MySQL database schema
GET
/Mysql/get_host_notes
Return remote MySQL host notes
GET
/Mysql/get_privileges_on_database
Return MySQL user privileges
GET
/Mysql/get_restrictions
Return MySQL name length restrictions
GET
/Mysql/get_server_information
Return MySQL server host information and version
GET
/Mysql/list_databases
Return MySQL databases
GET
/Mysql/list_routines
Return MySQL user routines
GET
/Mysql/list_users
Return MySQL users
GET
/Mysql/locate_server
Return MySQL server host information
GET
/Mysql/rename_database
Update MySQL database name
GET
/Mysql/rename_user
Update MySQL username
GET
/Mysql/repair_database
Repair MySQL database tables
GET
/Mysql/revoke_access_to_database
Remove MySQL user privileges
GET
/Mysql/set_password
Update MySQL user password
GET
/Mysql/set_privileges_on_database
Update MySQL user privileges
GET
/Mysql/setup_db_and_user
Create a randomly named MySQL username/database set.
GET
/Mysql/update_privileges
Update MySQL® privileges
NginxCaching 4
The NginxCaching module for UAPI.
GET
/NginxCaching/clear_cache
Delete NGINX cache contents.
GET
/NginxCaching/disable_cache
Disable the user's NGINX cache
GET
/NginxCaching/enable_cache
Enable the user's NGINX cache
GET
/NginxCaching/reset_cache_config
Reset the user's NGINX cache configuration
Notifications 1
The Notifications module for UAPI.
GET
/Notifications/get_notifications_count
Return server notifications total
Park 3
The Park module for UAPI.
GET
/Park/listparkeddomains
List the parked (aliased) domains
GET
/Park/park
Park an alias domain on an existing domain
GET
/Park/unpark
Remove a parked (aliased) domain
Parser 1
The Parser module for UAPI.
GET
/Parser/firstfile_relative_uri
Return session relative URI
PassengerApps 7
The PassengerApps module for UAPI.
GET
/PassengerApps/disable_application
Disable Passenger application
GET
/PassengerApps/edit_application
Update Passenger application settings
GET
/PassengerApps/enable_application
Enable Passenger application
GET
/PassengerApps/ensure_deps
Install Passenger application dependencies
GET
/PassengerApps/list_applications
Return Passenger applications
GET
/PassengerApps/register_application
Register Passenger application
GET
/PassengerApps/unregister_application
Unregister Passenger application
PasswdStrength 1
The PasswdStrength module for UAPI.
GET
/PasswdStrength/get_required_strength
Return minimum required password strength
Personalization 2
The Personalization module for UAPI.
POST
/Personalization/get
Retrieve NVData data from file
POST
/Personalization/set
Save NVData data to file
Plugins 2
The Plugins module for UAPI.
GET
/Plugins/can_show_promotions
Enable plugin promotions
GET
/Plugins/create_user
Create third-party user
Postgresql 14
The Postgresql module for UAPI.
GET
/Postgresql/create_database
Create PostgreSQL database
GET
/Postgresql/create_user
Create PostgreSQL user
GET
/Postgresql/delete_database
Delete PostgreSQL database
GET
/Postgresql/delete_user
Delete PostgreSQL user
GET
/Postgresql/get_restrictions
Return PostgreSQL name length restrictions
GET
/Postgresql/grant_all_privileges
Enable all user privileges on PostgreSQL database
GET
/Postgresql/list_databases
Return PostgreSQL databases
GET
/Postgresql/list_users
Return PostgreSQL users
GET
/Postgresql/rename_database
Update PostgreSQL database name
GET
/Postgresql/rename_user
Update PostgreSQL username
GET
/Postgresql/rename_user_no_password
Update PostgreSQL username without password
GET
/Postgresql/revoke_all_privileges
Remove PostgreSQL user privileges
GET
/Postgresql/set_password
Update PostgreSQL user password
GET
/Postgresql/update_privileges
Update PostgreSQL® privileges
Pushbullet 1
The Pushbullet module for UAPI.
GET
/Pushbullet/send_test_message
Validate Pushbullet token
Quota 2
The Quota module for UAPI.
GET
/Quota/get_local_quota_info
Return local disk quota information
GET
/Quota/get_quota_info
Return disk quota information
Resellers 1
The Resellers module for UAPI.
GET
/Resellers/list_accounts
Return reseller's cPanel accounts
ResourceUsage 1
The ResourceUsage module for UAPI.
GET
/ResourceUsage/get_usages
Return resource usage and custom statistics
SSH 2
The SSH module for UAPI.
GET
/SSH/get_port
Return SSH port
GET
/SSH/get_shell
Return whether cPanel account has shell access
SSL 50
The SSL module for UAPI.
GET
/SSL/add_autossl_excluded_domains
Disable AutoSSL for domains
GET
/SSL/can_ssl_redirect
Return whether domains can redirect to secure URL
GET
/SSL/check_shared_certdeprecated
Return whether shared SSL certificate exists
GET
/SSL/delete_cert
Delete SSL certificate
GET
/SSL/delete_csr
Delete certificate signing request
GET
/SSL/delete_key
Delete private key
GET
/SSL/delete_ssl
Remove SSL for domain
GET
/SSL/disable_mail_sni
Disable SNI mail services for domain
GET
/SSL/enable_mail_sni
Enable SNI mail services for domain
GET
/SSL/fetch_best_for_domain
Request best SSL certificate
GET
/SSL/fetch_cert_info
Return SSL certificate information
GET
/SSL/fetch_certificates_for_fqdns
Return SSL certificate information for all FQDN
POST
/SSL/fetch_key_and_cabundle_for_certificate
Return private key and CA bundle
GET
/SSL/find_certificates_for_key
Return SSL certificate for private key
GET
/SSL/find_csrs_for_key
Return private key's certificate signing requests
GET
/SSL/generate_cert
Create self-signed SSL certificate
GET
/SSL/generate_csr
Create certificate signing request
GET
/SSL/generate_key
Create private key
GET
/SSL/get_autossl_excluded_domains
Return AutoSSL disabled domains
GET
/SSL/get_autossl_problems
Return domains with AutoSSL problems
GET
/SSL/get_autossl_renewal_status
Return AutoSSL renewal status for a domain
GET
/SSL/get_cabundle
Return certificate's CA bundle and hostname
GET
/SSL/get_cn_name
Request best SSL domain for service
GET
/SSL/install_ssl
Install SSL certificate
GET
/SSL/installed_host
Return SSL certificate's info for dedicated IP
GET
/SSL/installed_hosts
Return domains with SSL certificate information
GET
/SSL/is_autossl_check_in_progress
Return whether AutoSSL check in progress
GET
/SSL/is_mail_sni_supported
Return whether mail SNI is enabled
GET
/SSL/is_sni_supported
Return whether Apache web server supports mail SNI
GET
/SSL/list_certs
Return all SSL certificates
GET
/SSL/list_csrs
Return all certificate signing requests
GET
/SSL/list_keys
Return all private keys
GET
/SSL/list_ssl_items
Return SSL-related items
GET
/SSL/mail_sni_status
Return status of domain's SNI mail services
GET
/SSL/rebuild_mail_sni_config
Start SNI configuration files rebuild
GET
/SSL/rebuildssldb
Start SSL database rebuild
GET
/SSL/remove_autossl_excluded_domains
Enable AutoSSL for specifed domains
GET
/SSL/set_autossl_excluded_domains
Disable AutoSSL for specifed domains
GET
/SSL/set_cert_friendly_name
Update SSL certificate's friendly name
GET
/SSL/set_csr_friendly_name
Update certificate signing request's friendly name
GET
/SSL/set_default_key_type
Update SSL TLS key type
GET
/SSL/set_key_friendly_name
Update private key's friendly name
GET
/SSL/set_primary_ssl
Update SSL website for dedicated IP address
GET
/SSL/show_cert
Export SSL certificate
GET
/SSL/show_csr
Export certificate signing request
GET
/SSL/show_key
Export private key
GET
/SSL/start_autossl_check
Start AutoSSL for current user
GET
/SSL/toggle_ssl_redirect_for_domains
Enable or disable secure redirects
POST
/SSL/upload_cert
Import SSL certificate
POST
/SSL/upload_key
Import private key
ServerInformation 1
The ServerInformation module for UAPI.
GET
/ServerInformation/get_information
Return service and device status
ServiceProxy 3
The ServiceProxy module for UAPI.
GET
/ServiceProxy/get_service_proxy_backends
Return a cPanel account’s service proxying setup
GET
/ServiceProxy/set_service_proxy_backends
Add cPanel account service proxying
GET
/ServiceProxy/unset_all_service_proxy_backends
Remove cPanel account service proxying
Session 4
The Session module for UAPI.
GET
/Session/create_temp_user
Create user session with existing session
GET
/Session/create_webmail_session_for_mail_user
Create Webmail session
GET
/Session/create_webmail_session_for_mail_user_check_password
Create Webmail session with credentials
GET
/Session/create_webmail_session_for_self
Create Webmail session for current user
SiteQuality 13
The SiteQuality module for UAPI.
POST
/SiteQuality/create_project
Add domain to monitoring
POST
/SiteQuality/create_site_quality_user
Register cPanel user for monitoring
GET
/SiteQuality/delete_site_quality_user
Delete Site Quality Monitoring account
POST
/SiteQuality/get_all_scores
Return all projects' monitoring results
GET
/SiteQuality/get_app_token
Return koality authentication token
GET
/SiteQuality/get_monitored_domains
Return the user's monitored domains.
GET
/SiteQuality/get_monitored_system_scores
Return status for a user's monitored domains.
GET
/SiteQuality/has_site_quality_user
Validate monitoring account existence
GET
/SiteQuality/is_site_quality_user_enabled
Validate monitoring account enablement
GET
/SiteQuality/reset_config
Remove monitoring user from cPanel configuration
GET
/SiteQuality/send_activation_email
Request activation email
POST
/SiteQuality/update_domain
Update domain name in Site Quality Monitoring project
GET
/SiteQuality/verify_code
Validate activation code
Sitejet 13
The Sitejet module for UAPI.
GET
/Sitejet/add_api_token
Add an existing Sitejet API token.
GET
/Sitejet/can_create_domains
Return Domain Availability
GET
/Sitejet/create_account
Generate a Sitejet API key.
GET
/Sitejet/create_restore_point
Create a restore point.
GET
/Sitejet/create_website
Create Sitejet domain ID
GET
/Sitejet/get_all_user_sitejet_info
Return Sitejet domains
GET
/Sitejet/get_api_token
Return Sitejet API token
GET
/Sitejet/get_preview_url
Return Sitejet preview URL
GET
/Sitejet/get_sso_link
Return Sitejet SSO URL
GET
/Sitejet/get_templatesdeprecated
Return Sitejet templates
GET
/Sitejet/restore_document_root
Restore a domain from the restore point.
GET
/Sitejet/set_templatedeprecated
Update Sitejet template
GET
/Sitejet/start_publish
Publish Sitejet domain
SpamAssassin 4
The SpamAssassin module for UAPI.
GET
/SpamAssassin/clear_spam_box
Delete spam box contents
GET
/SpamAssassin/get_symbolic_test_names
Return SpamAssassin™ symbolic test scores
GET
/SpamAssassin/get_user_preferences
Return SpamAssassin™ settings
GET
/SpamAssassin/update_user_preference
Update SpamAssassin™ settings
Stats 5
The Stats module for UAPI.
GET
/Stats/get_bandwidth
Return bandwidth statistics for all domains
GET
/Stats/get_site_errors
Return specified domain access log
GET
/Stats/get_stats_daily
Return daily AwStats statistics for a domain
GET
/Stats/list_sites
Return Analog statistics for all domains
GET
/Stats/list_stats_by_domain
Return Analog statistics for specified domain
StatsBar 1
The StatsBar module for UAPI.
GET
/StatsBar/get_stats
Return cPanel account statistics
StatsManager 2
The StatsManager module for UAPI.
GET
/StatsManager/get_configuration
Returns weblog analyzers' configuration
POST
/StatsManager/save_configuration
Save current user's weblog analyzers configuration
SubDomain 5
The SubDomain module for UAPI.
GET
/SubDomain/addsubdomain
Create subdomain
GET
/SubDomain/delsubdomain
Remove a subdomain
GET
/SubDomain/getreservedsubdomains
List the reserved subdomain names
GET
/SubDomain/listsubdomains
List the subdomains
GET
/SubDomain/validregex
Return the subdomain validation pattern
Subdomains 1
The SubDomain module for cPanel UAPI.
GET
/SubDomain/changedocroot
Change a subdomain or addon domain document root
Team Users 17
The Team User module for UAPI.
GET
/Team/add_roles
Add roles to a team user
GET
/Team/add_team_user
Add a team user
GET
/Team/cancel_expire
Stop a team user from expiring
GET
/Team/edit_team_user
Edit a team user
GET
/Team/get_team_users_with_roles_count
Get number of team users with roles
GET
/Team/list_team
List Team Users
GET
/Team/password_reset_request
Sends a password reset request link to team user.
GET
/Team/reinstate_team_user
Reinstate a team user
GET
/Team/remove_roles
Remove roles from a team user
GET
/Team/remove_team_user
Remove a team user
GET
/Team/set_contact_email
Set a contact email address for a team user
GET
/Team/set_expire
Set a team user to expire
GET
/Team/set_locale
Set locale for a team user
GET
/Team/set_notes
Set notes for a team user
GET
/Team/set_password
Set password for a team user
GET
/Team/set_roles
Set roles for a team user
GET
/Team/suspend_team_user
Suspend a team user
Team Roles 1
The Team Roles module for UAPI.
GET
/TeamRoles/list_feature_descriptions
List all role feature descriptions
Themes 3
The Themes module for UAPI.
GET
/Themes/get_theme_basedeprecated
Return current theme
GET
/Themes/list
Return available themes
GET
/Themes/update
Update current theme
Tokens 4
The Tokens module for UAPI.
GET
/Tokens/create_full_access
Create cPanel API token
GET
/Tokens/list
Return cPanel API tokens
GET
/Tokens/rename
Update cPanel API token's name
GET
/Tokens/revoke
Remove cPanel API token
Trash 1
The Trash module for UAPI.
POST
/Trash/remove
Permanently delete a single item from the trash
TwoFactorAuth 5
The TwoFactorAuth module for UAPI.
GET
/TwoFactorAuth/generate_user_configuration
Create 2FA authentication code
GET
/TwoFactorAuth/get_team_user_configuration
Return team user 2FA config
GET
/TwoFactorAuth/get_user_configuration
Return cPanel account 2FA config
GET
/TwoFactorAuth/remove_user_configuration
Remove 2FA config
GET
/TwoFactorAuth/set_user_configuration
Save 2FA config
UserData 2
The UserData module for cPanel UAPI.
GET
/UserData/get_scoped_userdata
Return scoped userdata mapping
GET
/UserData/set_scoped_userdata
Set scoped userdata key/value
UserManager 11
The UserManager module for UAPI.
GET
/UserManager/change_password
Update cPanel account password (User Manager)
GET
/UserManager/check_account_conflicts
Return Subaccounts and service accounts conflicts
GET
/UserManager/create_user
Create Subaccount
GET
/UserManager/delete_user
Delete Subaccount
GET
/UserManager/dismiss_merge
Remove service account link request
GET
/UserManager/edit_user
Update Subaccount settings
GET
/UserManager/list_users
Return cPanel account's Subaccounts
GET
/UserManager/lookup_service_account
Return service account's information
GET
/UserManager/lookup_user
Return Subaccount's information
GET
/UserManager/merge_service_account
Register service account to Subaccount
GET
/UserManager/unlink_service_account
Unregister service account from Subaccount
UserTasks 2
The UserTasks module for UAPI.
GET
/UserTasks/delete
Remove item from task queue
GET
/UserTasks/retrieve
Return task queue information
Users 1
The Users module for UAPI.
GET
/Users/change_password
Update cPanel account password
cPanel Server Information 1
Server Information / cPanel Server Information
GET
/Variables/get_server_information
Return server's configuration settings
Variables 2
The Variables module for UAPI.
GET
/Variables/get_session_information
Return web server's hostname
GET
/Variables/get_user_information
Return cPanel account's configuration settings
VersionControl 4
The VersionControl module for UAPI.
GET
/VersionControl/create
Create Git repository
GET
/VersionControl/delete
Delete Git repository
GET
/VersionControl/retrieve
Return Git repositories
GET
/VersionControl/update
Update Git repository settings
VersionControlDeployment 3
The VersionControlDeployment module for UAPI.
GET
/VersionControlDeployment/create
Create Git deployment task
GET
/VersionControlDeployment/delete
Delete Git deployment task
GET
/VersionControlDeployment/retrieve
Return Git deployment task status
WebApp 13
The WebApp module for UAPI.
GET
/WebApp/configure
Update an application's configuration.
GET
/WebApp/delete
Delete an application.
GET
/WebApp/deploy
Deploy an application.
GET
/WebApp/fetch_logs
Fetch an application's runtime or build logs.
GET
/WebApp/get_available
List available application runtimes and limits.
GET
/WebApp/has_feature
Report whether the Web Apps feature is available.
GET
/WebApp/list
List the account's web applications.
GET
/WebApp/redeploy
Redeploy an application, pulling source updates first.
GET
/WebApp/restart
Restart an application's server process.
GET
/WebApp/set_mode
Set an application's run mode.
GET
/WebApp/stage
Register a new web application.
GET
/WebApp/start
Start an application's server process.
GET
/WebApp/stop
Stop an application's server process.
WebDisk 4
The WebDisk module for UAPI.
GET
/WebDisk/delete_user
Delete Web Disk account
GET
/WebDisk/set_homedir
Update Web Disk home directory location
GET
/WebDisk/set_password
Update Web Disk account password
GET
/WebDisk/set_permissions
Update Web Disk home directory permissions
WebProsMCP 2
The WebProsMCP module for UAPI.
GET
/WebProsMCP/get_connection_config
Get the WebPros MCP connection configuration
GET
/WebProsMCP/unlink_webpros_account
Unlink the WebPros Account from this cPanel account
WebVhosts 2
The WebVhosts module for UAPI.
GET
/WebVhosts/list_domains
Return virtual host names for domains
GET
/WebVhosts/list_ssl_capable_domains
Return domains that allow SSL certificate purchase
WebmailApps 1
The WebmailApps module for UAPI.
GET
/WebmailApps/list_webmail_apps
Return available webmail clients
WordPressBackup 6
The WordPressBackup module for UAPI.
GET
/WordPressBackup/any_running
Return all WordPress sites' backup status
GET
/WordPressBackup/cancel
Stop WordPress site backup
GET
/WordPressBackup/cleanup
Delete WordPress backup temporary files
GET
/WordPressBackup/get_available_backups
Return WordPress site backups
GET
/WordPressBackup/is_running
Return WordPress site backup status
GET
/WordPressBackup/start
Backup WordPress site
WordPressRestore 3
The WordPressRestore module for UAPI.
GET
/WordPressRestore/any_running
Return WordPress site restore status
GET
/WordPressRestore/cleanup
Delete restored WordPress site's temporary files
GET
/WordPressRestore/start
Restore WordPress site
WordPressSite 2
The WordPressSite module for UAPI.
GET
/WordPressSite/create
Install WordPress site
GET
/WordPressSite/retrieve
Return WordPress site information
ZoneEdit 1
The ZoneEdit module for UAPI.
GET
/ZoneEdit/resetzone
Reset a DNS zone to the server defaults
cPGreyList 6
The cPGreyList module for UAPI.
GET
/cPGreyList/disable_all_domains
Disable Greylisting for all domains
GET
/cPGreyList/disable_domains
Disable Greylisting for specified domains
GET
/cPGreyList/enable_all_domains
Enable Greylisting for all domains
GET
/cPGreyList/enable_domains
Enable Greylisting for specified domains
GET
/cPGreyList/has_greylisting_enabled
Return whether Greylisting is enabled
GET
/cPGreyList/list_domains
Return Greylisting status for domains
Schemas 42
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are EditUserSubaccountBase (23 properties), LookupServiceAccountSubaccountBase (23 properties), MainDomainContents (22 properties), ServiceAccount (21 properties). Each schema is shown below with its type and property counts.
Contents
object
20 properties
CreateUserResponse
EditUserSubaccountBase
object
23 properties
FeatureDescriptions
object
3 properties
HashOutput
object
4 properties
ListOutput
LookupServiceAccountSubaccountBase
object
23 properties
LookupServiceAccountSubaccountMergeCandidates
object
1 property
LookupServiceAccountSubaccountMergeCandidatesEmpty
object
1 property
MainDomainContents
object
22 properties
MarketProviderProductMetaData
object
21 properties
MarketProviderProductMetaDataType
Payload
array
The zone’s content.
PricingPeriod
object
Pricing for a single registration period.
4 properties
ResponseBase
object
2 properties
ResponseComment
ResponseControl
ResponseControlOrComment
ResponseRR
RestoreInProgress
object
2 properties
RestoreNotInProgress
object
3 properties
SSLMarketProviderProductMetaData
object
Score
object
2 properties
ServiceAccount
object
21 properties
Services
object
3 properties
SubaccountBase
object
20 properties
SubaccountMergeCandidates
object
1 property
SubaccountMergeCandidatesEmpty
object
1 property
TeamArray
array
TeamHash
object
2 properties
index_type
string
The directory's indexing type. standard - The directory uses directory indexing with standard formatting. disabled - The directory doesn't use directory indexi…
trace_deliveryResponseBase
object
2 properties
trace_deliveryResponseBounce
trace_deliveryResponseCommand
trace_deliveryResponseDefer
trace_deliveryResponseDiscard
trace_deliveryResponseError
trace_deliveryResponseLocalDelivery
trace_deliveryResponseRemoteDelivery
trace_deliveryType
trace_deliveryTypeDescription
string
A type of trace node. The system returns this value to indicate the end of routing. bounce - The system rejected the email's delivery. command - The system wil…
schemas-TeamArray
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from cPanel 3
Other APIs cPanel publishes across the network.
WHM API 1
cPanel API 2 (Legacy)
Manage2 API
#Databases#Email#File#Hosting#REST#UAPI
Where this information came from
This is an independent, third-party profile of cPanel UAPI, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.