Skip to content

Latest commit

 

History

History
2984 lines (2943 loc) · 298 KB

README.md

File metadata and controls

2984 lines (2943 loc) · 298 KB

clientapi-cpanel

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

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 11.125.9901.267
  • Package version: 0.1.1
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://cpanel.net/support/

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/client-api/cpanel-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/client-api/cpanel-python.git)

Then import the package:

import clientapi_cpanel

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import clientapi_cpanel

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import clientapi_cpanel
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.APITokenManagementApi(api_client)
    name = 'example' # str | The API token's name.  **Note:**  The name may **only** contain alphanumeric characters, dashes (`-`), and underscores (`_`).
    expires_at = 1609372800 # int | The API token's expiration time.  **Important:**  * When an API token expires the system does **not** delete it. You **must** manually delete expired API tokens. * If you do not use this parameter, the API token will **not** expire. (optional)

    try:
        # Create cPanel API token
        api_response = api_instance.create_full_access(name, expires_at=expires_at)
        print("The response of APITokenManagementApi->create_full_access:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APITokenManagementApi->create_full_access: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://cpanel-server.tld:2083/execute

Class Method HTTP request Description
APITokenManagementApi create_full_access GET /Tokens/create_full_access Create cPanel API token
APITokenManagementApi rename GET /Tokens/rename Update cPanel API token's name
APITokenManagementApi revoke GET /Tokens/revoke Remove cPanel API token
APITokenManagementApi tokens_list GET /Tokens/list Return cPanel API tokens
AccountEnhancementsApi account_enhancements_has_enhancement GET /AccountEnhancements/has_enhancement Validate Account Enhancement assignment
AccountEnhancementsApi account_enhancements_list GET /AccountEnhancements/list Return all cPanel account's Account Enhancements
AccountInformationApi list_accounts GET /Resellers/list_accounts Return reseller's cPanel accounts
AccountInformationApi variables_get_user_information GET /Variables/get_user_information Return cPanel account's configuration settings
AccountManagementApi change_password GET /UserManager/change_password Update cPanel account password
AntivirusProtectionClamAVApi clam_scanner_check_disinfection_status GET /ClamScanner/check_disinfection_status Request disinfection process status
AntivirusProtectionClamAVApi clam_scanner_get_scan_paths GET /ClamScanner/get_scan_paths Return virus scan types
AntivirusProtectionClamAVApi clam_scanner_get_scan_status GET /ClamScanner/get_scan_status Request virus scan status
AntivirusProtectionClamAVApi clam_scanner_list_infected_files GET /ClamScanner/list_infected_files Return infected file list
AntivirusProtectionClamAVApi clam_scanner_start_scan GET /ClamScanner/start_scan Start virus scan
AntivirusProtectionClamAVApi disinfect_files POST /ClamScanner/disinfect_files Start disinfecting files with viruses
ApplicationInformationApi get_application_information GET /Branding/get_application_information Return single app's info from dynamicui.conf
ApplicationInformationApi get_applications GET /Branding/get_applications Return multiple apps' info from dynamicui.conf
ApplicationInformationApi get_available_applications GET /Branding/get_available_applications Return current user's cPanel application details
ApplicationInformationApi get_information_for_applications GET /Branding/get_information_for_applications Return app's info from sitemap.json
ApplicationManagerApi disable_application GET /PassengerApps/disable_application Disable Passenger application
ApplicationManagerApi edit_application GET /PassengerApps/edit_application Update Passenger application settings
ApplicationManagerApi enable_application GET /PassengerApps/enable_application Enable Passenger application
ApplicationManagerApi ensure_deps GET /PassengerApps/ensure_deps Install Passenger application dependencies
ApplicationManagerApi list_applications GET /PassengerApps/list_applications Return Passenger applications
ApplicationManagerApi register_application GET /PassengerApps/register_application Register Passenger application
ApplicationManagerApi unregister_application GET /PassengerApps/unregister_application Unregister Passenger application
AutoGeneratedSSLCertificatesApi add_autossl_excluded_domains GET /SSL/add_autossl_excluded_domains Disable AutoSSL for domains
AutoGeneratedSSLCertificatesApi get_autossl_excluded_domains GET /SSL/get_autossl_excluded_domains Return AutoSSL disabled domains
AutoGeneratedSSLCertificatesApi get_autossl_problems GET /SSL/get_autossl_problems Return domains with AutoSSL problems
AutoGeneratedSSLCertificatesApi is_autossl_check_in_progress GET /SSL/is_autossl_check_in_progress Return whether AutoSSL check in progress
AutoGeneratedSSLCertificatesApi remove_autossl_excluded_domains GET /SSL/remove_autossl_excluded_domains Enable AutoSSL for specifed domains
AutoGeneratedSSLCertificatesApi set_autossl_excluded_domains GET /SSL/set_autossl_excluded_domains Disable AutoSSL for specifed domains
AutoGeneratedSSLCertificatesApi start_autossl_check GET /SSL/start_autossl_check Start AutoSSL for current user
BackupApi fullbackup_to_ftp GET /Backup/fullbackup_to_ftp Back up cPanel account via FTP
BackupApi fullbackup_to_homedir GET /Backup/fullbackup_to_homedir Back up cPanel account to home directory
BackupApi fullbackup_to_scp_with_key GET /Backup/fullbackup_to_scp_with_key Back up cPanel account via SCP with SSH key
BackupApi fullbackup_to_scp_with_password GET /Backup/fullbackup_to_scp_with_password Back up cPanel account via SCP with password
BackupApi list_backups GET /Backup/list_backups Return backup files
BandwidthApi get_enabled_protocols GET /Bandwidth/get_enabled_protocols Return services monitored in bandwidth data
BandwidthApi get_retention_periods GET /Bandwidth/get_retention_periods Return bandwidth retention period
BandwidthApi query GET /Bandwidth/query Return cPanel account's bandwidth usage report
BatchApi strict GET /Batch/strict Run multiple UAPI functions in order
BlockIPApi blockip_add_ip GET /BlockIP/add_ip Add IP address to cPanel account's block list
BlockIPApi blockip_remove_ip GET /BlockIP/remove_ip Remove IP address from cPanel account's block list
BlockIPApi blockip_add_ip GET /BlockIP/add_ip Add IP address to cPanel account's block list
BlockIPApi blockip_remove_ip GET /BlockIP/remove_ip Remove IP address from cPanel account's block list
BoxTrapperApi blacklist_messages GET /BoxTrapper/blacklist_messages Add email address to BoxTrapper blocked senders
BoxTrapperApi box_trapper_get_allowlist GET /BoxTrapper/get_allowlist Return account BoxTrapper allowlist rules
BoxTrapperApi box_trapper_get_blocklist GET /BoxTrapper/get_blocklist Return account BoxTrapper blocklist rules
BoxTrapperApi box_trapper_get_ignorelist GET /BoxTrapper/get_ignorelist Return account BoxTrapper ignorelist rules
BoxTrapperApi box_trapper_set_allowlist GET /BoxTrapper/set_allowlist Update account BoxTrapper allowlist
BoxTrapperApi box_trapper_set_blocklist GET /BoxTrapper/set_blocklist Update account BoxTrapper blocklist
BoxTrapperApi box_trapper_set_ignorelist GET /BoxTrapper/set_ignorelist Update account BoxTrapper ignorelist
BoxTrapperApi delete_messages GET /BoxTrapper/delete_messages Delete messages in the BoxTrapper queue
BoxTrapperApi deliver_messages GET /BoxTrapper/deliver_messages Send messages in the BoxTrapper queue
BoxTrapperApi get_configuration GET /BoxTrapper/get_configuration Return email account's BoxTrapper configuration
BoxTrapperApi get_email_template GET /BoxTrapper/get_email_template Return specified BoxTrapper email template
BoxTrapperApi get_forwarders GET /BoxTrapper/get_forwarders Return all BoxTrapper forwarders
BoxTrapperApi get_log GET /BoxTrapper/get_log Return BoxTrapper log file and contents
BoxTrapperApi get_message GET /BoxTrapper/get_message Return message's top 200 lines in BoxTrapper queue
BoxTrapperApi get_status GET /BoxTrapper/get_status Return whether email account uses BoxTrapper
BoxTrapperApi ignore_messages GET /BoxTrapper/ignore_messages Add email account to Exim ignore list
BoxTrapperApi list_email_templates GET /BoxTrapper/list_email_templates Return BoxTrapper email templates
BoxTrapperApi list_queued_messages GET /BoxTrapper/list_queued_messages Return email account's BoxTrapper queued messages
BoxTrapperApi process_messages GET /BoxTrapper/process_messages Run a specific BoxTrapper action for a message
BoxTrapperApi reset_email_template GET /BoxTrapper/reset_email_template Restore default BoxTrapper email message template
BoxTrapperApi save_configuration GET /BoxTrapper/save_configuration Update email account's BoxTrapper configuration
BoxTrapperApi save_email_template GET /BoxTrapper/save_email_template Save BoxTrapper message template contents
BoxTrapperApi set_forwarders GET /BoxTrapper/set_forwarders Add email address to BoxTrapper forwarders
BoxTrapperApi set_status GET /BoxTrapper/set_status Enable or disable BoxTrapper for email account
BoxTrapperApi whitelist_messages GET /BoxTrapper/whitelist_messages Add email address to BoxTrapper allowed senders
BrandManagementApi get_dom GET /Chrome/get_dom Return cPanel theme header and footer HTML
BrandingApi get_application_information GET /Branding/get_application_information Return single app's info from dynamicui.conf
BrandingApi get_applications GET /Branding/get_applications Return multiple apps' info from dynamicui.conf
BrandingApi get_available_applications GET /Branding/get_available_applications Return current user's cPanel application details
BrandingApi get_information_for_applications GET /Branding/get_information_for_applications Return app's info from sitemap.json
BrowserCacheManagementApi cache_buster_read GET /CacheBuster/read Return web browser cached file override ID
BrowserCacheManagementApi update GET /CacheBuster/update Create web browser cached file override ID
CCSApi add_delegate GET /CCS/add_delegate Add calendar delegation
CCSApi list_delegates GET /CCS/list_delegates List cPanel account's calendar delegates
CCSApi list_users GET /CCS/list_users List cPanel account's calendar users
CCSApi remove_delegate GET /CCS/remove_delegate Remove calendar delegation
CCSApi update_delegate GET /CCS/update_delegate Update calendar delegation
CSVImportApi c_sv_import_doimport GET /CSVImport/doimport Import email accounts from CSV file
CacheBusterApi cache_buster_read GET /CacheBuster/read Return web browser cached file override ID
CacheBusterApi update GET /CacheBuster/update Create web browser cached file override ID
CalendarAndContactsServerApi add_delegate GET /CCS/add_delegate Add calendar delegation
CalendarAndContactsServerApi list_delegates GET /CCS/list_delegates List cPanel account's calendar delegates
CalendarAndContactsServerApi list_users GET /CCS/list_users List cPanel account's calendar users
CalendarAndContactsServerApi remove_delegate GET /CCS/remove_delegate Remove calendar delegation
CalendarAndContactsServerApi update_delegate GET /CCS/update_delegate Update calendar delegation
CalendarAndContactsDAVApi c_pdavd_add_delegate GET /CPDAVD/add_delegate Share a calendar
CalendarAndContactsDAVApi c_pdavd_list_delegates GET /CPDAVD/list_delegates List calendar sharing.
CalendarAndContactsDAVApi c_pdavd_list_users GET /CPDAVD/list_users Update calendar sharing
CalendarAndContactsDAVApi c_pdavd_manage_collection GET /CPDAVD/manage_collection Perform an operation on a calendar or address book.
CalendarAndContactsDAVApi c_pdavd_remove_delegate GET /CPDAVD/remove_delegate Remove a share.
CalendarAndContactsDAVApi c_pdavd_update_delegate GET /CPDAVD/update_delegate Update calendar sharing.
CalendarAndContactsDAVApi disable_shared_global_addressbook GET /DAV/disable_shared_global_addressbook Disable global address book
CalendarAndContactsDAVApi enable_shared_global_addressbook GET /DAV/enable_shared_global_addressbook Enable global address book
CalendarAndContactsDAVApi get_calendar_contacts_config GET /DAV/get_calendar_contacts_config Return CalDAV and CardDAV connection information
CalendarAndContactsDAVApi has_shared_global_addressbook GET /DAV/has_shared_global_addressbook Return whether global address book is enabled
CalendarAndContactsDAVApi is_dav_service_enabled GET /DAV/is_dav_service_enabled Return whether DAV is enabled
CalendarAndContactsDAVApi is_horde_enabled GET /DAV/is_horde_enabled Return whether Horde is enabled
ChkservdApi get_exim_ports GET /Chkservd/get_exim_ports Return outgoing (SMTP) mail port
ChkservdApi get_exim_ports_ssl GET /Chkservd/get_exim_ports_ssl Return outgoing mail (SMTP) SSL-secured port
ChromeApi get_dom GET /Chrome/get_dom Return cPanel theme header and footer HTML
ClamScannerApi clam_scanner_check_disinfection_status GET /ClamScanner/check_disinfection_status Request disinfection process status
ClamScannerApi clam_scanner_get_scan_paths GET /ClamScanner/get_scan_paths Return virus scan types
ClamScannerApi clam_scanner_get_scan_status GET /ClamScanner/get_scan_status Request virus scan status
ClamScannerApi clam_scanner_list_infected_files GET /ClamScanner/list_infected_files Return infected file list
ClamScannerApi clam_scanner_start_scan GET /ClamScanner/start_scan Start virus scan
ClamScannerApi disinfect_files POST /ClamScanner/disinfect_files Start disinfecting files with viruses
ContactInformationApi contactinformation_set_email_addresses GET /ContactInformation/set_email_addresses Set contact email address(es)
ContactInformationApi contactinformation_unset_email_addresses GET /ContactInformation/unset_email_addresses Unset contact email addresses
ContactInformationApi contactinformation_set_email_addresses GET /ContactInformation/set_email_addresses Set contact email address(es)
ContactInformationApi contactinformation_unset_email_addresses GET /ContactInformation/unset_email_addresses Unset contact email addresses
ContactInformationApi is_enabled GET /Contactus/is_enabled Return whether contact option is enabled
ContactusApi is_enabled GET /Contactus/is_enabled Return whether contact option is enabled
DAVApi c_pdavd_add_delegate GET /CPDAVD/add_delegate Share a calendar
DAVApi c_pdavd_list_delegates GET /CPDAVD/list_delegates List calendar sharing.
DAVApi c_pdavd_list_users GET /CPDAVD/list_users Update calendar sharing
DAVApi c_pdavd_manage_collection GET /CPDAVD/manage_collection Perform an operation on a calendar or address book.
DAVApi c_pdavd_remove_delegate GET /CPDAVD/remove_delegate Remove a share.
DAVApi c_pdavd_update_delegate GET /CPDAVD/update_delegate Update calendar sharing.
DAVApi disable_shared_global_addressbook GET /DAV/disable_shared_global_addressbook Disable global address book
DAVApi enable_shared_global_addressbook GET /DAV/enable_shared_global_addressbook Enable global address book
DAVApi get_calendar_contacts_config GET /DAV/get_calendar_contacts_config Return CalDAV and CardDAV connection information
DAVApi has_shared_global_addressbook GET /DAV/has_shared_global_addressbook Return whether global address book is enabled
DAVApi is_dav_service_enabled GET /DAV/is_dav_service_enabled Return whether DAV is enabled
DAVApi is_horde_enabled GET /DAV/is_horde_enabled Return whether Horde is enabled
DCVApi check_domains_via_dns POST /DCV/check_domains_via_dns Verify domain ownership via DNS
DCVApi check_domains_via_http GET /DCV/check_domains_via_http Verify domain ownership via HTTP
DCVApi ensure_domains_can_pass_dcv GET /DCV/ensure_domains_can_pass_dcv Verify domain ownership
DNSApi d_ns_swap_ip_in_zones GET /DNS/swap_ip_in_zones Update IP addresses in zone files
DNSApi d_nsis_alias_available GET /DNS/is_alias_available Return `ALIAS` DNS record availability & resolver
DNSApi dns_lookup GET /DNS/lookup Return domain's DNS information
DNSApi dns_mass_edit_zone GET /DNS/mass_edit_zone Update a DNS zone
DNSApi dns_parse_zone GET /DNS/parse_zone Return a parsed DNS zone
DNSApi ensure_domains_reside_only_locally GET /DNS/ensure_domains_reside_only_locally Return whether domains only resolve locally
DNSApi has_local_authority GET /DNS/has_local_authority Return whether local DNS server is authoritative
DNSSECApi activate_zone_key GET /DNSSEC/activate_zone_key Enable DNSSEC security key
DNSSECApi add_zone_key GET /DNSSEC/add_zone_key Create DNSSEC security key
DNSSECApi deactivate_zone_key GET /DNSSEC/deactivate_zone_key Disable DNSSEC security key
DNSSECApi disable_dnssec GET /DNSSEC/disable_dnssec Disable DNSSEC
DNSSECApi enable_dnssec GET /DNSSEC/enable_dnssec Enable DNSSEC
DNSSECApi export_zone_dnskey GET /DNSSEC/export_zone_dnskey Export DNSKEY record value
DNSSECApi export_zone_key GET /DNSSEC/export_zone_key Export DNSSEC security key
DNSSECApi fetch_ds_records GET /DNSSEC/fetch_ds_records Return domain's DS records
DNSSECApi import_zone_key GET /DNSSEC/import_zone_key Add DNSSEC security key
DNSSECApi remove_zone_key GET /DNSSEC/remove_zone_key Remove DNSSEC security key
DNSSECApi set_nsec3 GET /DNSSEC/set_nsec3 Update domain to use NSEC3
DNSSECApi unset_nsec3 GET /DNSSEC/unset_nsec3 Update domain to use NSEC
DNSInformationApi d_nsis_alias_available GET /DNS/is_alias_available Return `ALIAS` DNS record availability & resolver
DNSInformationApi dns_lookup GET /DNS/lookup Return domain's DNS information
DNSInformationApi dns_mass_edit_zone GET /DNS/mass_edit_zone Update a DNS zone
DNSInformationApi dns_parse_zone GET /DNS/parse_zone Return a parsed DNS zone
DNSInformationApi ensure_domains_reside_only_locally GET /DNS/ensure_domains_reside_only_locally Return whether domains only resolve locally
DNSInformationApi has_local_authority GET /DNS/has_local_authority Return whether local DNS server is authoritative
DNSSecurityApi activate_zone_key GET /DNSSEC/activate_zone_key Enable DNSSEC security key
DNSSecurityApi add_zone_key GET /DNSSEC/add_zone_key Create DNSSEC security key
DNSSecurityApi deactivate_zone_key GET /DNSSEC/deactivate_zone_key Disable DNSSEC security key
DNSSecurityApi disable_dnssec GET /DNSSEC/disable_dnssec Disable DNSSEC
DNSSecurityApi enable_dnssec GET /DNSSEC/enable_dnssec Enable DNSSEC
DNSSecurityApi export_zone_dnskey GET /DNSSEC/export_zone_dnskey Export DNSKEY record value
DNSSecurityApi export_zone_key GET /DNSSEC/export_zone_key Export DNSSEC security key
DNSSecurityApi fetch_ds_records GET /DNSSEC/fetch_ds_records Return domain's DS records
DNSSecurityApi import_zone_key GET /DNSSEC/import_zone_key Add DNSSEC security key
DNSSecurityApi remove_zone_key GET /DNSSEC/remove_zone_key Remove DNSSEC security key
DNSSecurityApi set_nsec3 GET /DNSSEC/set_nsec3 Update domain to use NSEC3
DNSSecurityApi unset_nsec3 GET /DNSSEC/unset_nsec3 Update domain to use NSEC
DatabaseInformationApi get_server_information GET /Mysql/get_server_information Return MySQL server host information and version
DatabaseInformationApi locate_server GET /Mysql/locate_server Return MySQL server host information
DatabaseManagementApi create_database GET /Mysql/create_database Create MySQL database
DatabaseManagementApi delete_database GET /Mysql/delete_database Delete MySQL database
DatabaseManagementApi dump_database_schema GET /Mysql/dump_database_schema Return MySQL database schema
DatabaseManagementApi list_databases GET /Mysql/list_databases Return MySQL databases
DatabaseManagementApi mysql_check_database GET /Mysql/check_database Validate MySQL database integrity
DatabaseManagementApi mysql_rename_database GET /Mysql/rename_database Update MySQL database name
DatabaseManagementApi mysql_update_privileges GET /Mysql/update_privileges Update MySQL® privileges
DatabaseManagementApi repair_database GET /Mysql/repair_database Repair MySQL database tables
DatabaseManagementApi setup_db_and_user GET /Mysql/setup_db_and_user Create a randomly named MySQL username/database set.
DeploymentSettingsApi delete GET /VersionControlDeployment/delete Delete Git deployment task
DeploymentSettingsApi version_control_deployment_create GET /VersionControlDeployment/create Create Git deployment task
DeploymentSettingsApi version_control_deployment_retrieve GET /VersionControlDeployment/retrieve Return Git deployment task status
DirectLinkProtectionHotlinkApi add_hotlink GET /Mime/add_hotlink Enable hotlink protection
DirectLinkProtectionHotlinkApi delete_hotlink GET /Mime/delete_hotlink Disable hotlink protection
DirectLinkProtectionHotlinkApi list_hotlinks GET /Mime/list_hotlinks Return domains with hotlink protection
DirectoryIndexesApi directory_indexes_list_directories GET /DirectoryIndexes/list_directories Return subdirectories directory indexing settings
DirectoryIndexesApi get_indexing GET /DirectoryIndexes/get_indexing Return directory indexing settings
DirectoryIndexesApi set_indexing GET /DirectoryIndexes/set_indexing Update directory indexing settings
DirectoryPrivacyApi add_user GET /DirectoryPrivacy/add_user Add authorized user for protected directory
DirectoryPrivacyApi configure_directory_protection GET /DirectoryPrivacy/configure_directory_protection Enable or disable protected directory
DirectoryPrivacyApi delete_user GET /DirectoryPrivacy/delete_user Delete authorized user for protected directory
DirectoryPrivacyApi directory_privacy_list_directories GET /DirectoryPrivacy/list_directories Return privacy status of subdirectories
DirectoryPrivacyApi directory_privacy_list_users GET /DirectoryPrivacy/list_users Return authorized users for protected directory
DirectoryPrivacyApi is_directory_protected GET /DirectoryPrivacy/is_directory_protected Return whether directory uses password protection
DirectoryProtectionApi directory_protection_list_directories GET /DirectoryProtection/list_directories Return Directory Protection settings
DirectoryIndexesApi directory_indexes_list_directories GET /DirectoryIndexes/list_directories Return subdirectories directory indexing settings
DirectoryIndexesApi get_indexing GET /DirectoryIndexes/get_indexing Return directory indexing settings
DirectoryIndexesApi set_indexing GET /DirectoryIndexes/set_indexing Update directory indexing settings
DirectoryPrivacyApi add_user GET /DirectoryPrivacy/add_user Add authorized user for protected directory
DirectoryPrivacyApi configure_directory_protection GET /DirectoryPrivacy/configure_directory_protection Enable or disable protected directory
DirectoryPrivacyApi delete_user GET /DirectoryPrivacy/delete_user Delete authorized user for protected directory
DirectoryPrivacyApi directory_privacy_list_directories GET /DirectoryPrivacy/list_directories Return privacy status of subdirectories
DirectoryPrivacyApi directory_privacy_list_users GET /DirectoryPrivacy/list_users Return authorized users for protected directory
DirectoryPrivacyApi is_directory_protected GET /DirectoryPrivacy/is_directory_protected Return whether directory uses password protection
DirectoryProtectionApi directory_protection_list_directories GET /DirectoryProtection/list_directories Return Directory Protection settings
DiskQuotasApi get_local_quota_info GET /Quota/get_local_quota_info Return local disk quota information
DiskQuotasApi get_quota_info GET /Quota/get_quota_info Return disk quota information
DomainInfoApi domains_data GET /DomainInfo/domains_data Return all domains' hosting configuration
DomainInfoApi list_domains GET /DomainInfo/list_domains Return cPanel account's domains
DomainInfoApi main_domain_builtin_subdomain_aliases GET /DomainInfo/main_domain_builtin_subdomain_aliases Return built-in subdomain aliases
DomainInfoApi single_domain_data GET /DomainInfo/single_domain_data Return domain's hosting configuration
DomainInformationApi domains_data GET /DomainInfo/domains_data Return all domains' hosting configuration
DomainInformationApi list_domains GET /DomainInfo/list_domains Return cPanel account's domains
DomainInformationApi main_domain_builtin_subdomain_aliases GET /DomainInfo/main_domain_builtin_subdomain_aliases Return built-in subdomain aliases
DomainInformationApi single_domain_data GET /DomainInfo/single_domain_data Return domain's hosting configuration
DomainRedirectionApi add_redirect GET /Mime/add_redirect Add redirect to domain
DomainRedirectionApi delete_redirect GET /Mime/delete_redirect Remove redirect from domain
DomainRedirectionApi get_redirect GET /Mime/get_redirect Return redirect URL for domain
DomainRedirectionApi list_redirects GET /Mime/list_redirects Return .htaccess files' redirects
DomainStatisticsApi get_bandwidth GET /Stats/get_bandwidth Return bandwidth statistics for all domains
DomainStatisticsApi get_site_errors GET /Stats/get_site_errors Return specified domain access log
DomainStatisticsApi list_sites GET /Stats/list_sites Return Analog statistics for all domains
DomainStatisticsApi list_stats_by_domain GET /Stats/list_stats_by_domain Return Analog statistics for specified domain
DynamicDNSApi dynamicdns_create GET /DynamicDNS/create Create Dynamic DNS domain
DynamicDNSApi dynamicdns_delete GET /DynamicDNS/delete Delete Dynamic DNS domain
DynamicDNSApi dynamicdns_list GET /DynamicDNS/list Return Dynamic DNS domains
DynamicDNSApi dynamicdns_recreate GET /DynamicDNS/recreate Update Dynamic DNS domain ID
DynamicDNSApi dynamicdns_set_description GET /DynamicDNS/set_description Update Dynamic DNS domain description
DynamicDNSApi dynamicdns_create GET /DynamicDNS/create Create Dynamic DNS domain
DynamicDNSApi dynamicdns_delete GET /DynamicDNS/delete Delete Dynamic DNS domain
DynamicDNSApi dynamicdns_list GET /DynamicDNS/list Return Dynamic DNS domains
DynamicDNSApi dynamicdns_recreate GET /DynamicDNS/recreate Update Dynamic DNS domain ID
DynamicDNSApi dynamicdns_set_description GET /DynamicDNS/set_description Update Dynamic DNS domain description
EA4Api get_recommendations GET /get_recommendations Get EA4 configuration recommendations
EmailApi account_name GET /Email/account_name Return current user's account name
EmailApi add_auto_responder GET /Email/add_auto_responder Create email account's autoresponder
EmailApi add_domain_forwarder GET /Email/add_domain_forwarder Create domain-level forwarder
EmailApi add_forwarder GET /Email/add_forwarder Create email account forwarder
EmailApi add_list GET /Email/add_list Create mailing list
EmailApi add_mailman_delegates GET /Email/add_mailman_delegates Add administrators to mailing list
EmailApi add_pop GET /Email/add_pop Create email address
EmailApi add_spam_filter GET /Email/add_spam_filter Update minimum spam score threshold value
EmailApi browse_mailbox GET /Email/browse_mailbox Return mail directory's subdirectories and files
EmailApi check_fastmail GET /Email/check_fastmail Return BlackBerry FastMail support status
EmailApi count_auto_responders GET /Email/count_auto_responders Return cPanel account's autoresponders total
EmailApi count_filters GET /Email/count_filters Return cPanel account's email filters total
EmailApi count_forwarders GET /Email/count_forwarders Return cPanel account's mail forwarder total
EmailApi count_lists GET /Email/count_lists Return cPanel account's mailing list total
EmailApi count_pops GET /Email/count_pops Return cPanel account's email account total
EmailApi delete_auto_responder GET /Email/delete_auto_responder Delete email account's autoresponder
EmailApi delete_domain_forwarder GET /Email/delete_domain_forwarder Delete domain-level forwarder
EmailApi delete_filter GET /Email/delete_filter Delete email account's email filter
EmailApi delete_forwarder GET /Email/delete_forwarder Delete email account's email forwarder
EmailApi delete_held_messages GET /Email/delete_held_messages Delete email account's outgoing messages
EmailApi delete_list GET /Email/delete_list Delete mailing list
EmailApi delete_pop GET /Email/delete_pop Delete email address
EmailApi disable_filter GET /Email/disable_filter Disable email filter for email account
EmailApi disable_mailbox_autocreate GET /Email/disable_mailbox_autocreate Disable cPanel account mailbox autocreation
EmailApi disable_spam_assassin GET /Email/disable_spam_assassin Disable Apache SpamAssassin for cPanel account
EmailApi disable_spam_autodelete GET /Email/disable_spam_autodelete Disable spam box filtering auto-delete
EmailApi disable_spam_box GET /Email/disable_spam_box Disable spam box filtering for cPanel account
EmailApi dispatch_client_settings GET /Email/dispatch_client_settings Send email client settings to an email address
EmailApi edit_pop_quota GET /Email/edit_pop_quota Update email account's quota
EmailApi email_terminate_mailbox_sessions GET /Email/terminate_mailbox_sessions Stop cPanel account IMAP and POP3 connections
EmailApi enable_filter GET /Email/enable_filter Enable email filter for email account
EmailApi enable_mailbox_autocreate GET /Email/enable_mailbox_autocreate Enable cPanel account mailbox autocreation
EmailApi enable_spam_assassin GET /Email/enable_spam_assassin Enable Apache SpamAssassin for cPanel account
EmailApi enable_spam_box GET /Email/enable_spam_box Enable spam box filtering for cPanel account
EmailApi export_lists GET /Email/export_lists Export cPanel account's Mailman mailing lists to a file
EmailApi fetch_charmaps GET /Email/fetch_charmaps Return server's supported character encodings
EmailApi fts_rescan_mailbox GET /Email/fts_rescan_mailbox Start IMAP Full-Text Search scan for email account
EmailApi generate_mailman_otp GET /Email/generate_mailman_otp Create one-time password for a mailing list
EmailApi get_auto_responder GET /Email/get_auto_responder Return email account's autoresponder information
EmailApi get_charsets GET /Email/get_charsets Return mail server's supported character encodings
EmailApi get_client_settings GET /Email/get_client_settings Return email account's client settings
EmailApi get_default_email_quota GET /Email/get_default_email_quota Return email account's default email quota
EmailApi get_default_email_quota_mib GET /Email/get_default_email_quota_mib Return email account's default email quota in MiB
EmailApi get_disk_usage GET /Email/get_disk_usage Return email account's disk usage
EmailApi get_filter GET /Email/get_filter Return email filter's information
EmailApi get_held_message_count GET /Email/get_held_message_count Return email account's outgoing message count
EmailApi get_lists_total_disk_usage GET /Email/get_lists_total_disk_usage Return cPanel account's mailing list disk usage
EmailApi get_mailbox_autocreate GET /Email/get_mailbox_autocreate Return cPanel account's mailbox autocreate status
EmailApi get_mailman_delegates GET /Email/get_mailman_delegates Return mailing list administrators
EmailApi get_main_account_disk_usage GET /Email/get_main_account_disk_usage Return primary email account's disk usage
EmailApi get_main_account_disk_usage_bytes GET /Email/get_main_account_disk_usage_bytes Return primary email account's disk usage in bytes
EmailApi get_max_email_quota GET /Email/get_max_email_quota Return email account's max quota size
EmailApi get_max_email_quota_mib GET /Email/get_max_email_quota_mib Return email account's max quota size in MiB
EmailApi get_pop_quota GET /Email/get_pop_quota Return email account's quota
EmailApi get_spam_settings GET /Email/get_spam_settings Return email account Apache SpamAssassin settings
EmailApi get_webmail_settings GET /Email/get_webmail_settings Return email account's Webmail settings
EmailApi has_delegated_mailman_lists GET /Email/has_delegated_mailman_lists Return email account's mailing list privileges
EmailApi has_plaintext_authentication GET /Email/has_plaintext_authentication Return whether plaintext authentication is enabled
EmailApi hold_outgoing GET /Email/hold_outgoing Stop email account's outgoing mail
EmailApi list_auto_responders GET /Email/list_auto_responders Return domain's autoresponders
EmailApi list_default_address GET /Email/list_default_address Return domain's default email address
EmailApi list_domain_forwarders GET /Email/list_domain_forwarders Return domain-level forwarders
EmailApi list_filters GET /Email/list_filters Return account-level email filters
EmailApi list_filters_backups GET /Email/list_filters_backups Return domains with domain-level email filters
EmailApi list_forwarders GET /Email/list_forwarders Return domain's forwarders
EmailApi list_forwarders_backups GET /Email/list_forwarders_backups Return domains with domain-level forwarders
EmailApi list_lists GET /Email/list_lists Return cPanel account's mailing lists
EmailApi list_mail_domains GET /Email/list_mail_domains Return cPanel account's mail domains
EmailApi list_pops GET /Email/list_pops Return email accounts
EmailApi list_pops_with_disk GET /Email/list_pops_with_disk Return email accounts with disk information
EmailApi list_system_filter_info GET /Email/list_system_filter_info Return system-level email filter file information
EmailApi passwd_list GET /Email/passwd_list Update mailing list password
EmailApi passwd_pop GET /Email/passwd_pop Update email account password
EmailApi release_outgoing GET /Email/release_outgoing Start email account outgoing mail
EmailApi remove_mailman_delegates GET /Email/remove_mailman_delegates Remove account mailing list admin privileges
EmailApi reorder_filters GET /Email/reorder_filters Update email address's email filter order
EmailApi set_always_accept GET /Email/set_always_accept Update Mail Exchanger type
EmailApi set_default_address GET /Email/set_default_address Create default email address
EmailApi set_list_privacy_options GET /Email/set_list_privacy_options Update mailing list privacy options
EmailApi set_manual_mx_redirects GET /Email/set_manual_mx_redirects Add manual MX redirection
EmailApi stats_db_status GET /Email/stats_db_status Return eximstats SQLite database status
EmailApi store_filter GET /Email/store_filter Create email filter
EmailApi suspend_incoming GET /Email/suspend_incoming Suspend email account incoming (SMTP) mail
EmailApi suspend_login GET /Email/suspend_login Suspend email account login
EmailApi suspend_outgoing GET /Email/suspend_outgoing Suspend email account outgoing mail
EmailApi trace_delivery GET /Email/trace_delivery Run email delivery route trace
EmailApi trace_filter GET /Email/trace_filter Run test for main domain email filters
EmailApi unset_manual_mx_redirects GET /Email/unset_manual_mx_redirects Remove manual MX redirection
EmailApi unsuspend_incoming GET /Email/unsuspend_incoming Unsuspend email account incoming mail
EmailApi unsuspend_login GET /Email/unsuspend_login Unsuspend email account login
EmailApi unsuspend_outgoing GET /Email/unsuspend_outgoing Unsuspend email account outgoing mail
EmailApi verify_password GET /Email/verify_password Validate email account password
EmailAuthApi disable_dkim GET /EmailAuth/disable_dkim Remove domains' DKIM records
EmailAuthApi email_auth_apply_dmarc GET /EmailAuth/apply_dmarc Apply DMARC records to domains.
EmailAuthApi email_auth_remove_dmarc GET /EmailAuth/remove_dmarc Remove DMARC record from domain(s)
EmailAuthApi email_auth_validate_current_dmarcs GET /EmailAuth/validate_current_dmarcs Validate domains' DMARC records
EmailAuthApi enable_dkim GET /EmailAuth/enable_dkim Enable domains' DKIM records
EmailAuthApi ensure_dkim_keys_exist GET /EmailAuth/ensure_dkim_keys_exist Validate domains' DKIM private keys
EmailAuthApi fetch_dkim_private_keys GET /EmailAuth/fetch_dkim_private_keys Return domains' DKIM private keys
EmailAuthApi install_dkim_private_keys GET /EmailAuth/install_dkim_private_keys Add domains' DKIM record keys
EmailAuthApi install_spf_records GET /EmailAuth/install_spf_records Add domains' SPF records
EmailAuthApi validate_current_dkims GET /EmailAuth/validate_current_dkims Validate domains' DKIM records
EmailAuthApi validate_current_ptrs GET /EmailAuth/validate_current_ptrs Validate domains' PTR records
EmailAuthApi validate_current_spfs GET /EmailAuth/validate_current_spfs Validate domains' SPF records
EmailAccountsApi account_name GET /Email/account_name Return current user's account name
EmailAccountsApi add_auto_responder GET /Email/add_auto_responder Create email account's autoresponder
EmailAccountsApi add_pop GET /Email/add_pop Create email address
EmailAccountsApi browse_mailbox GET /Email/browse_mailbox Return mail directory's subdirectories and files
EmailAccountsApi c_sv_import_doimport GET /CSVImport/doimport Import email accounts from CSV file
EmailAccountsApi count_auto_responders GET /Email/count_auto_responders Return cPanel account's autoresponders total
EmailAccountsApi count_pops GET /Email/count_pops Return cPanel account's email account total
EmailAccountsApi delete_auto_responder GET /Email/delete_auto_responder Delete email account's autoresponder
EmailAccountsApi delete_held_messages GET /Email/delete_held_messages Delete email account's outgoing messages
EmailAccountsApi delete_pop GET /Email/delete_pop Delete email address
EmailAccountsApi dispatch_client_settings GET /Email/dispatch_client_settings Send email client settings to an email address
EmailAccountsApi edit_pop_quota GET /Email/edit_pop_quota Update email account's quota
EmailAccountsApi email_terminate_mailbox_sessions GET /Email/terminate_mailbox_sessions Stop cPanel account IMAP and POP3 connections
EmailAccountsApi get_auto_responder GET /Email/get_auto_responder Return email account's autoresponder information
EmailAccountsApi get_client_settings GET /Email/get_client_settings Return email account's client settings
EmailAccountsApi get_default_email_quota GET /Email/get_default_email_quota Return email account's default email quota
EmailAccountsApi get_default_email_quota_mib GET /Email/get_default_email_quota_mib Return email account's default email quota in MiB
EmailAccountsApi get_disk_usage GET /Email/get_disk_usage Return email account's disk usage
EmailAccountsApi get_held_message_count GET /Email/get_held_message_count Return email account's outgoing message count
EmailAccountsApi get_main_account_disk_usage GET /Email/get_main_account_disk_usage Return primary email account's disk usage
EmailAccountsApi get_main_account_disk_usage_bytes GET /Email/get_main_account_disk_usage_bytes Return primary email account's disk usage in bytes
EmailAccountsApi get_max_email_quota GET /Email/get_max_email_quota Return email account's max quota size
EmailAccountsApi get_max_email_quota_mib GET /Email/get_max_email_quota_mib Return email account's max quota size in MiB
EmailAccountsApi get_pop_quota GET /Email/get_pop_quota Return email account's quota
EmailAccountsApi get_webmail_settings GET /Email/get_webmail_settings Return email account's Webmail settings
EmailAccountsApi hold_outgoing GET /Email/hold_outgoing Stop email account's outgoing mail
EmailAccountsApi list_auto_responders GET /Email/list_auto_responders Return domain's autoresponders
EmailAccountsApi list_default_address GET /Email/list_default_address Return domain's default email address
EmailAccountsApi list_mail_domains GET /Email/list_mail_domains Return cPanel account's mail domains
EmailAccountsApi list_pops GET /Email/list_pops Return email accounts
EmailAccountsApi list_pops_with_disk GET /Email/list_pops_with_disk Return email accounts with disk information
EmailAccountsApi passwd_pop GET /Email/passwd_pop Update email account password
EmailAccountsApi release_outgoing GET /Email/release_outgoing Start email account outgoing mail
EmailAccountsApi set_default_address GET /Email/set_default_address Create default email address
EmailAccountsApi set_manual_mx_redirects GET /Email/set_manual_mx_redirects Add manual MX redirection
EmailAccountsApi trace_delivery GET /Email/trace_delivery Run email delivery route trace
EmailAccountsApi unset_manual_mx_redirects GET /Email/unset_manual_mx_redirects Remove manual MX redirection
EmailAccountsApi verify_password GET /Email/verify_password Validate email account password
EmailDNSSettingsApi add_mx GET /Email/add_mx Create mail exchanger record
EmailDNSSettingsApi change_mx GET /Email/change_mx Update mail exchanger record
EmailDNSSettingsApi delete_mx GET /Email/delete_mx Delete mail exchanger record
EmailDNSSettingsApi disable_dkim GET /EmailAuth/disable_dkim Remove domains' DKIM records
EmailDNSSettingsApi email_auth_apply_dmarc GET /EmailAuth/apply_dmarc Apply DMARC records to domains.
EmailDNSSettingsApi email_auth_remove_dmarc GET /EmailAuth/remove_dmarc Remove DMARC record from domain(s)
EmailDNSSettingsApi email_auth_validate_current_dmarcs GET /EmailAuth/validate_current_dmarcs Validate domains' DMARC records
EmailDNSSettingsApi enable_dkim GET /EmailAuth/enable_dkim Enable domains' DKIM records
EmailDNSSettingsApi ensure_dkim_keys_exist GET /EmailAuth/ensure_dkim_keys_exist Validate domains' DKIM private keys
EmailDNSSettingsApi fetch_dkim_private_keys GET /EmailAuth/fetch_dkim_private_keys Return domains' DKIM private keys
EmailDNSSettingsApi install_dkim_private_keys GET /EmailAuth/install_dkim_private_keys Add domains' DKIM record keys
EmailDNSSettingsApi install_spf_records GET /EmailAuth/install_spf_records Add domains' SPF records
EmailDNSSettingsApi list_mxs GET /Email/list_mxs Return mail exchanger records
EmailDNSSettingsApi validate_current_dkims GET /EmailAuth/validate_current_dkims Validate domains' DKIM records
EmailDNSSettingsApi validate_current_ptrs GET /EmailAuth/validate_current_ptrs Validate domains' PTR records
EmailDNSSettingsApi validate_current_spfs GET /EmailAuth/validate_current_spfs Validate domains' SPF records
EmailFilteringApi count_filters GET /Email/count_filters Return cPanel account's email filters total
EmailFilteringApi delete_filter GET /Email/delete_filter Delete email account's email filter
EmailFilteringApi disable_filter GET /Email/disable_filter Disable email filter for email account
EmailFilteringApi enable_filter GET /Email/enable_filter Enable email filter for email account
EmailFilteringApi get_filter GET /Email/get_filter Return email filter's information
EmailFilteringApi list_filters GET /Email/list_filters Return account-level email filters
EmailFilteringApi list_filters_backups GET /Email/list_filters_backups Return domains with domain-level email filters
EmailFilteringApi list_system_filter_info GET /Email/list_system_filter_info Return system-level email filter file information
EmailFilteringApi reorder_filters GET /Email/reorder_filters Update email address's email filter order
EmailFilteringApi store_filter GET /Email/store_filter Create email filter
EmailFilteringApi trace_filter GET /Email/trace_filter Run test for main domain email filters
EmailForwardingApi add_domain_forwarder GET /Email/add_domain_forwarder Create domain-level forwarder
EmailForwardingApi add_forwarder GET /Email/add_forwarder Create email account forwarder
EmailForwardingApi count_forwarders GET /Email/count_forwarders Return cPanel account's mail forwarder total
EmailForwardingApi delete_domain_forwarder GET /Email/delete_domain_forwarder Delete domain-level forwarder
EmailForwardingApi delete_forwarder GET /Email/delete_forwarder Delete email account's email forwarder
EmailForwardingApi list_domain_forwarders GET /Email/list_domain_forwarders Return domain-level forwarders
EmailForwardingApi list_forwarders GET /Email/list_forwarders Return domain's forwarders
EmailForwardingApi list_forwarders_backups GET /Email/list_forwarders_backups Return domains with domain-level forwarders
EmailServerInformationApi check_fastmail GET /Email/check_fastmail Return BlackBerry FastMail support status
EmailServerInformationApi disable_mailbox_autocreate GET /Email/disable_mailbox_autocreate Disable cPanel account mailbox autocreation
EmailServerInformationApi enable_mailbox_autocreate GET /Email/enable_mailbox_autocreate Enable cPanel account mailbox autocreation
EmailServerInformationApi fetch_charmaps GET /Email/fetch_charmaps Return server's supported character encodings
EmailServerInformationApi fts_rescan_mailbox GET /Email/fts_rescan_mailbox Start IMAP Full-Text Search scan for email account
EmailServerInformationApi get_charsets GET /Email/get_charsets Return mail server's supported character encodings
EmailServerInformationApi get_mailbox_autocreate GET /Email/get_mailbox_autocreate Return cPanel account's mailbox autocreate status
EmailServerInformationApi has_plaintext_authentication GET /Email/has_plaintext_authentication Return whether plaintext authentication is enabled
EmailServerInformationApi set_always_accept GET /Email/set_always_accept Update Mail Exchanger type
EmailServerInformationApi stats_db_status GET /Email/stats_db_status Return eximstats SQLite database status
EmailSuspensionsApi suspend_incoming GET /Email/suspend_incoming Suspend email account incoming (SMTP) mail
EmailSuspensionsApi suspend_login GET /Email/suspend_login Suspend email account login
EmailSuspensionsApi suspend_outgoing GET /Email/suspend_outgoing Suspend email account outgoing mail
EmailSuspensionsApi unsuspend_incoming GET /Email/unsuspend_incoming Unsuspend email account incoming mail
EmailSuspensionsApi unsuspend_login GET /Email/unsuspend_login Unsuspend email account login
EmailSuspensionsApi unsuspend_outgoing GET /Email/unsuspend_outgoing Unsuspend email account outgoing mail
ExternalAuthenticationApi add_authn_link GET /ExternalAuthentication/add_authn_link Add external authentication link
ExternalAuthenticationApi configured_modules GET /ExternalAuthentication/configured_modules Return server's external authentication providers
ExternalAuthenticationApi get_authn_links GET /ExternalAuthentication/get_authn_links Return external authentication links
ExternalAuthenticationApi has_external_auth_modules_configured GET /ExternalAuthentication/has_external_auth_modules_configured Return external authentication user status
ExternalAuthenticationApi remove_authn_link GET /ExternalAuthentication/remove_authn_link Remove external authentication link
ExternalAuthenticationApi add_authn_link GET /ExternalAuthentication/add_authn_link Add external authentication link
ExternalAuthenticationApi configured_modules GET /ExternalAuthentication/configured_modules Return server's external authentication providers
ExternalAuthenticationApi get_authn_links GET /ExternalAuthentication/get_authn_links Return external authentication links
ExternalAuthenticationApi has_external_auth_modules_configured GET /ExternalAuthentication/has_external_auth_modules_configured Return external authentication user status
ExternalAuthenticationApi remove_authn_link GET /ExternalAuthentication/remove_authn_link Remove external authentication link
FTPAccountsApi add_ftp GET /Ftp/add_ftp Create FTP account
FTPAccountsApi delete_ftp GET /Ftp/delete_ftp Delete FTP account
FTPAccountsApi ftp_exists GET /Ftp/ftp_exists Return whether an FTP account exists
FTPAccountsApi get_quota GET /Ftp/get_quota Return FTP account's quota
FTPAccountsApi get_welcome_message GET /Ftp/get_welcome_message Return FTP account's welcome message
FTPAccountsApi list_ftp GET /Ftp/list_ftp Return FTP accounts
FTPAccountsApi list_ftp_with_disk GET /Ftp/list_ftp_with_disk Return FTP accounts and disk usage
FTPAccountsApi passwd GET /Ftp/passwd Update FTP account's password
FTPAccountsApi set_homedir GET /Ftp/set_homedir Update FTP account's home directory
FTPAccountsApi set_quota GET /Ftp/set_quota Update FTP account's quota
FTPAccountsApi set_welcome_message GET /Ftp/set_welcome_message Update FTP welcome message
FTPServerSettingsApi allows_anonymous_ftp GET /Ftp/allows_anonymous_ftp Return if anonymous FTP connections allowed
FTPServerSettingsApi allows_anonymous_ftp_incoming GET /Ftp/allows_anonymous_ftp_incoming Return if anonymous FTP transfers allowed
FTPServerSettingsApi get_ftp_daemon_info GET /Ftp/get_ftp_daemon_info Return FTP server's information
FTPServerSettingsApi get_port GET /Ftp/get_port Return FTP server's port
FTPServerSettingsApi kill_session GET /Ftp/kill_session Stop FTP session
FTPServerSettingsApi list_sessions GET /Ftp/list_sessions Return FTP server's active sessions
FTPServerSettingsApi server_name GET /Ftp/server_name Return whether server uses ProFTPD or Pure-FTPd
FTPServerSettingsApi set_anonymous_ftp GET /Ftp/set_anonymous_ftp Enable or disable anonymous FTP logins
FTPServerSettingsApi set_anonymous_ftp_incoming GET /Ftp/set_anonymous_ftp_incoming Enable or disable anonymous incoming FTP transfers
FeaturesApi get_feature_metadata GET /Features/get_feature_metadata Return cPanel account's features' metadata
FeaturesApi has_feature GET /Features/has_feature Validate cPanel account's feature access
FeaturesApi list_features GET /Features/list_features Return cPanel account's features
FileRestorationApi directory_listing GET /Restore/directory_listing Return backups in home directory
FileRestorationApi get_users GET /Restore/get_users Return cPanel accounts with backup metadata
FileRestorationApi query_file_info GET /Restore/query_file_info Return backup storage locations
FileRestorationApi restore_databases POST /Backup/restore_databases Restore databases
FileRestorationApi restore_email_filters POST /Backup/restore_email_filters Restore email filters
FileRestorationApi restore_email_forwarders POST /Backup/restore_email_forwarders Restore email forwarders
FileRestorationApi restore_file GET /Restore/restore_file Restore file or directory
FileRestorationApi restore_files POST /Backup/restore_files Restore files
FilemanApi autocompletedir GET /Fileman/autocompletedir Return autocomplete file and directory names
FilemanApi empty_trash GET /Fileman/empty_trash Delete .trash folder content
FilemanApi get_file_content GET /Fileman/get_file_content Return file content
FilemanApi get_file_information GET /Fileman/get_file_information Return file or directory information
FilemanApi list_files GET /Fileman/list_files Return directory content
FilemanApi save_file_content GET /Fileman/save_file_content Save file
FilemanApi transcode GET /Fileman/transcode Update buffer encoding
FilemanApi upload_files GET /Fileman/upload_files Upload files
FtpApi add_ftp GET /Ftp/add_ftp Create FTP account
FtpApi allows_anonymous_ftp GET /Ftp/allows_anonymous_ftp Return if anonymous FTP connections allowed
FtpApi allows_anonymous_ftp_incoming GET /Ftp/allows_anonymous_ftp_incoming Return if anonymous FTP transfers allowed
FtpApi delete_ftp GET /Ftp/delete_ftp Delete FTP account
FtpApi ftp_exists GET /Ftp/ftp_exists Return whether an FTP account exists
FtpApi get_ftp_daemon_info GET /Ftp/get_ftp_daemon_info Return FTP server's information
FtpApi get_port GET /Ftp/get_port Return FTP server's port
FtpApi get_quota GET /Ftp/get_quota Return FTP account's quota
FtpApi get_welcome_message GET /Ftp/get_welcome_message Return FTP account's welcome message
FtpApi kill_session GET /Ftp/kill_session Stop FTP session
FtpApi list_ftp GET /Ftp/list_ftp Return FTP accounts
FtpApi list_ftp_with_disk GET /Ftp/list_ftp_with_disk Return FTP accounts and disk usage
FtpApi list_sessions GET /Ftp/list_sessions Return FTP server's active sessions
FtpApi passwd GET /Ftp/passwd Update FTP account's password
FtpApi server_name GET /Ftp/server_name Return whether server uses ProFTPD or Pure-FTPd
FtpApi set_anonymous_ftp GET /Ftp/set_anonymous_ftp Enable or disable anonymous FTP logins
FtpApi set_anonymous_ftp_incoming GET /Ftp/set_anonymous_ftp_incoming Enable or disable anonymous incoming FTP transfers
FtpApi set_homedir GET /Ftp/set_homedir Update FTP account's home directory
FtpApi set_quota GET /Ftp/set_quota Update FTP account's quota
FtpApi set_welcome_message GET /Ftp/set_welcome_message Update FTP welcome message
GPGApi delete_keypair GET /GPG/delete_keypair Delete GnuPG key pair
GPGApi export_public_key GET /GPG/export_public_key Export GnuPG public key
GPGApi export_secret_key GET /GPG/export_secret_key Export GnuPG secret key
GPGApi generate_key GET /GPG/generate_key Create GnuPG key
GPGApi import_key GET /GPG/import_key Import GnuPG key
GPGApi list_public_keys GET /GPG/list_public_keys Return current user's GnuPG public keys
GPGApi list_secret_keys GET /GPG/list_secret_keys Return current user's GnuPG secret keys
HandlerManagementApi add_handler GET /Mime/add_handler Add web server MIME type handler
HandlerManagementApi delete_handler GET /Mime/delete_handler Remove web server MIME type handler
HandlerManagementApi list_handlers GET /Mime/list_handlers Return web server's MIME handlers
HandlerManagementApi redirect_info GET /Mime/redirect_info Return redirect information
ImageManagerApi convert_file GET /ImageManager/convert_file Create image with new format
ImageManagerApi create_thumbnails GET /ImageManager/create_thumbnails Create image thumbnails
ImageManagerApi get_dimensions GET /ImageManager/get_dimensions Return image dimensions
ImageManagerApi resize_image GET /ImageManager/resize_image Save resized image
ImageToolsApi convert_file GET /ImageManager/convert_file Create image with new format
ImageToolsApi create_thumbnails GET /ImageManager/create_thumbnails Create image thumbnails
ImageToolsApi get_dimensions GET /ImageManager/get_dimensions Return image dimensions
ImageToolsApi resize_image GET /ImageManager/resize_image Save resized image
IntegrationApi fetch_url GET /Integration/fetch_url Return integrated application URL
KnownHostsApi create GET /KnownHosts/create Create host
KnownHostsApi known_hosts_delete GET /KnownHosts/delete Delete host
KnownHostsApi known_hosts_update GET /KnownHosts/update Update host in the known_hosts file
KnownHostsApi verify GET /KnownHosts/verify Validate host
KnownSSHHostsManagementApi create GET /KnownHosts/create Create host
KnownSSHHostsManagementApi known_hosts_delete GET /KnownHosts/delete Delete host
KnownSSHHostsManagementApi known_hosts_update GET /KnownHosts/update Update host in the known_hosts file
KnownSSHHostsManagementApi verify GET /KnownHosts/verify Validate host
LangPHPApi php_get_domain_handler GET /LangPHP/php_get_domain_handler Return PHP version's handler
LangPHPApi php_get_impacted_domains GET /LangPHP/php_get_impacted_domains Return domains that shared PHP configuration
LangPHPApi php_get_installed_versions GET /LangPHP/php_get_installed_versions Return installed PHP versions
LangPHPApi php_get_system_default_version GET /LangPHP/php_get_system_default_version Return default PHP version
LangPHPApi php_get_vhost_versions GET /LangPHP/php_get_vhost_versions Return virtual host's PHP version
LangPHPApi php_ini_get_user_basic_directives GET /LangPHP/php_ini_get_user_basic_directives Return basic PHP directives
LangPHPApi php_ini_get_user_content GET /LangPHP/php_ini_get_user_content Return virtual host's php.ini content
LangPHPApi php_ini_get_user_paths GET /LangPHP/php_ini_get_user_paths Return php.ini file paths
LangPHPApi php_ini_set_user_basic_directives GET /LangPHP/php_ini_set_user_basic_directives Update basic PHP directives
LangPHPApi php_ini_set_user_content GET /LangPHP/php_ini_set_user_content Update virtual host's php.ini content
LangPHPApi php_set_vhost_versions GET /LangPHP/php_set_vhost_versions Update virtual host's PHP version
LanguageApi get_attributes GET /Locale/get_attributes Return current locale settings
LanguageApi list_locales GET /Locale/list_locales Return available locales
LanguageApi set_locale GET /Locale/set_locale Update cPanel account locale
LastLoginApi get_last_or_current_logged_in_ip GET /LastLogin/get_last_or_current_logged_in_ip Return last authenticated login IP address
LocaleApi get_attributes GET /Locale/get_attributes Return current locale settings
LocaleApi list_locales GET /Locale/list_locales Return available locales
LocaleApi set_locale GET /Locale/set_locale Update cPanel account locale
LogManagerApi get_settings GET /LogManager/get_settings Retrieve cPanel account's log archival settings
LogManagerApi list_archives GET /LogManager/list_archives Return cPanel account's archive files list
LogManagerApi set_settings GET /LogManager/set_settings Save cPanel account's log archive settings
LoginInformationApi get_last_or_current_logged_in_ip GET /LastLogin/get_last_or_current_logged_in_ip Return last authenticated login IP address
LoginInformationApi get_session_information GET /Variables/get_session_information Return web server's hostname
LogsApi get_settings GET /LogManager/get_settings Retrieve cPanel account's log archival settings
LogsApi list_archives GET /LogManager/list_archives Return cPanel account's archive files list
LogsApi set_settings GET /LogManager/set_settings Save cPanel account's log archive settings
MailServerInformationApi get_exim_ports GET /Chkservd/get_exim_ports Return outgoing (SMTP) mail port
MailServerInformationApi get_exim_ports_ssl GET /Chkservd/get_exim_ports_ssl Return outgoing mail (SMTP) SSL-secured port
MailboxManagementApi expunge_mailbox_messages GET /Mailboxes/expunge_mailbox_messages Delete selected messages in mailbox
MailboxManagementApi expunge_messages_for_mailbox_guid GET /Mailboxes/expunge_messages_for_mailbox_guid Delete selected messages in mailbox by GUID
MailboxManagementApi get_mailbox_status_list GET /Mailboxes/get_mailbox_status_list Return cPanel account's mailbox status
MailboxManagementApi has_utf8_mailbox_names GET /Mailboxes/has_utf8_mailbox_names Return if cPanel account's mailboxes use UTF-8
MailboxManagementApi set_utf8_mailbox_names GET /Mailboxes/set_utf8_mailbox_names Enable or disable Webmail mailbox UTF-8 encoding
MailboxesApi expunge_mailbox_messages GET /Mailboxes/expunge_mailbox_messages Delete selected messages in mailbox
MailboxesApi expunge_messages_for_mailbox_guid GET /Mailboxes/expunge_messages_for_mailbox_guid Delete selected messages in mailbox by GUID
MailboxesApi get_mailbox_status_list GET /Mailboxes/get_mailbox_status_list Return cPanel account's mailbox status
MailboxesApi has_utf8_mailbox_names GET /Mailboxes/has_utf8_mailbox_names Return if cPanel account's mailboxes use UTF-8
MailboxesApi set_utf8_mailbox_names GET /Mailboxes/set_utf8_mailbox_names Enable or disable Webmail mailbox UTF-8 encoding
MailingListsApi add_list GET /Email/add_list Create mailing list
MailingListsApi add_mailman_delegates GET /Email/add_mailman_delegates Add administrators to mailing list
MailingListsApi count_lists GET /Email/count_lists Return cPanel account's mailing list total
MailingListsApi delete_list GET /Email/delete_list Delete mailing list
MailingListsApi export_lists GET /Email/export_lists Export cPanel account's Mailman mailing lists to a file
MailingListsApi generate_mailman_otp GET /Email/generate_mailman_otp Create one-time password for a mailing list
MailingListsApi get_lists_total_disk_usage GET /Email/get_lists_total_disk_usage Return cPanel account's mailing list disk usage
MailingListsApi get_mailman_delegates GET /Email/get_mailman_delegates Return mailing list administrators
MailingListsApi has_delegated_mailman_lists GET /Email/has_delegated_mailman_lists Return email account's mailing list privileges
MailingListsApi list_lists GET /Email/list_lists Return cPanel account's mailing lists
MailingListsApi passwd_list GET /Email/passwd_list Update mailing list password
MailingListsApi remove_mailman_delegates GET /Email/remove_mailman_delegates Remove account mailing list admin privileges
MailingListsApi set_list_privacy_options GET /Email/set_list_privacy_options Update mailing list privacy options
ManageFilesApi autocompletedir GET /Fileman/autocompletedir Return autocomplete file and directory names
ManageFilesApi empty_trash GET /Fileman/empty_trash Delete .trash folder content
ManageFilesApi get_file_content GET /Fileman/get_file_content Return file content
ManageFilesApi get_file_information GET /Fileman/get_file_information Return file or directory information
ManageFilesApi list_files GET /Fileman/list_files Return directory content
ManageFilesApi save_file_content GET /Fileman/save_file_content Save file
ManageFilesApi transcode GET /Fileman/transcode Update buffer encoding
ManageFilesApi upload_files GET /Fileman/upload_files Upload files
MarketApi cancel_pending_ssl_certificate GET /Market/cancel_pending_ssl_certificate Delete an order
MarketApi create_shopping_cart GET /Market/create_shopping_cart Create shopping cart
MarketApi get_certificate_status_details GET /Market/get_certificate_status_details Return provider's SSL certificate request status
MarketApi get_login_url GET /Market/get_login_url Return provider's login URL
MarketApi get_pending_ssl_certificates GET /Market/get_pending_ssl_certificates Return provider's pending SSL certificates
MarketApi get_ssl_certificate_if_available GET /Market/get_ssl_certificate_if_available Return provider's available SSL certificates
MarketApi market_get_all_products GET /Market/get_all_products Return provider's available products
MarketApi market_get_provider_specific_dcv_constraints GET /Market/get_provider_specific_dcv_constraints Return provider's DCV filename requirements
MarketApi market_get_providers_list GET /Market/get_providers_list Return enabled providers
MarketApi process_ssl_pending_queue GET /Market/process_ssl_pending_queue Start processing pending queue's SSL certificates
MarketApi request_ssl_certificates GET /Market/request_ssl_certificates Request SSL certificate order
MarketApi set_status_of_pending_queue_items GET /Market/set_status_of_pending_queue_items Update status of items in pending queue
MarketApi set_url_after_checkout GET /Market/set_url_after_checkout Update URL after checkout
MarketApi validate_login_token GET /Market/validate_login_token Validate login token
MarketIntegrationApi create_shopping_cart GET /Market/create_shopping_cart Create shopping cart
MarketIntegrationApi get_login_url GET /Market/get_login_url Return provider's login URL
MarketIntegrationApi market_get_all_products GET /Market/get_all_products Return provider's available products
MarketIntegrationApi market_get_providers_list GET /Market/get_providers_list Return enabled providers
MarketIntegrationApi set_status_of_pending_queue_items GET /Market/set_status_of_pending_queue_items Update status of items in pending queue
MarketIntegrationApi set_url_after_checkout GET /Market/set_url_after_checkout Update URL after checkout
MarketIntegrationApi validate_login_token GET /Market/validate_login_token Validate login token
MimeApi add_handler GET /Mime/add_handler Add web server MIME type handler
MimeApi add_hotlink GET /Mime/add_hotlink Enable hotlink protection
MimeApi add_mime GET /Mime/add_mime Add MIME type to web server
MimeApi add_redirect GET /Mime/add_redirect Add redirect to domain
MimeApi delete_handler GET /Mime/delete_handler Remove web server MIME type handler
MimeApi delete_hotlink GET /Mime/delete_hotlink Disable hotlink protection
MimeApi delete_mime GET /Mime/delete_mime Remove MIME type from web server
MimeApi delete_redirect GET /Mime/delete_redirect Remove redirect from domain
MimeApi get_redirect GET /Mime/get_redirect Return redirect URL for domain
MimeApi list_handlers GET /Mime/list_handlers Return web server's MIME handlers
MimeApi list_hotlinks GET /Mime/list_hotlinks Return domains with hotlink protection
MimeApi list_mime GET /Mime/list_mime Return web server's MIME types
MimeApi list_redirects GET /Mime/list_redirects Return .htaccess files' redirects
MimeApi redirect_info GET /Mime/redirect_info Return redirect information
MimeTypeManagementApi add_mime GET /Mime/add_mime Add MIME type to web server
MimeTypeManagementApi delete_mime GET /Mime/delete_mime Remove MIME type from web server
MimeTypeManagementApi list_mime GET /Mime/list_mime Return web server's MIME types
ModSecurityApi disable_all_domains GET /ModSecurity/disable_all_domains Disable ModSecurity for all domains
ModSecurityApi disable_domains GET /ModSecurity/disable_domains Disable ModSecurity for selected domains
ModSecurityApi enable_all_domains GET /ModSecurity/enable_all_domains Enable ModSecurity for all domains
ModSecurityApi enable_domains GET /ModSecurity/enable_domains Enable ModSecurity for selected domains
ModSecurityApi has_modsecurity_installed GET /ModSecurity/has_modsecurity_installed Return ModSecurity installation status
ModSecurityApi mod_security_list_domains GET /ModSecurity/list_domains Return ModSecurity domains' status
MysqlApi add_host GET /Mysql/add_host Enable remote MySQL host access
MysqlApi create_database GET /Mysql/create_database Create MySQL database
MysqlApi delete_database GET /Mysql/delete_database Delete MySQL database
MysqlApi delete_host GET /Mysql/delete_host Disable remote MySQL host access
MysqlApi dump_database_schema GET /Mysql/dump_database_schema Return MySQL database schema
MysqlApi get_host_notes GET /Mysql/get_host_notes Return remote MySQL host notes
MysqlApi get_restrictions GET /Mysql/get_restrictions Return MySQL name length restrictions
MysqlApi get_server_information GET /Mysql/get_server_information Return MySQL server host information and version
MysqlApi list_databases GET /Mysql/list_databases Return MySQL databases
MysqlApi list_routines GET /Mysql/list_routines Return MySQL user routines
MysqlApi locate_server GET /Mysql/locate_server Return MySQL server host information
MysqlApi mysql_add_host_note GET /Mysql/add_host_note Add remote MySQL host note
MysqlApi mysql_check_database GET /Mysql/check_database Validate MySQL database integrity
MysqlApi mysql_create_user GET /Mysql/create_user Create MySQL user
MysqlApi mysql_delete_user GET /Mysql/delete_user Delete MySQL user
MysqlApi mysql_get_privileges_on_database GET /Mysql/get_privileges_on_database Return MySQL user privileges
MysqlApi mysql_list_users GET /Mysql/list_users Return MySQL users
MysqlApi mysql_rename_database GET /Mysql/rename_database Update MySQL database name
MysqlApi mysql_set_password GET /Mysql/set_password Update MySQL user password
MysqlApi mysql_update_privileges GET /Mysql/update_privileges Update MySQL® privileges
MysqlApi rename_user GET /Mysql/rename_user Update MySQL username
MysqlApi repair_database GET /Mysql/repair_database Repair MySQL database tables
MysqlApi revoke_access_to_database GET /Mysql/revoke_access_to_database Remove MySQL user privileges
MysqlApi set_privileges_on_database GET /Mysql/set_privileges_on_database Update MySQL user privileges
MysqlApi setup_db_and_user GET /Mysql/setup_db_and_user Create a randomly named MySQL username/database set.
NginxCachingApi clear_cache GET /NginxCaching/clear_cache Delete NGINX cache contents.
NginxCachingApi disable_cache GET /NginxCaching/disable_cache Disable the user's NGINX cache
NginxCachingApi enable_cache GET /NginxCaching/enable_cache Enable the user's NGINX cache
NginxCachingApi reset_cache_config GET /NginxCaching/reset_cache_config Reset the user's NGINX cache configuration
NotificationsApi get_notifications_count GET /Notifications/get_notifications_count Return server notifications total
PHPApi e_a4_get_php_recommendations GET /get_php_recommendations Get custom PHP recommendations.
PHPSettingsApi php_get_domain_handler GET /LangPHP/php_get_domain_handler Return PHP version's handler
PHPSettingsApi php_get_impacted_domains GET /LangPHP/php_get_impacted_domains Return domains that shared PHP configuration
PHPSettingsApi php_get_installed_versions GET /LangPHP/php_get_installed_versions Return installed PHP versions
PHPSettingsApi php_get_system_default_version GET /LangPHP/php_get_system_default_version Return default PHP version
PHPSettingsApi php_get_vhost_versions GET /LangPHP/php_get_vhost_versions Return virtual host's PHP version
PHPSettingsApi php_ini_get_user_basic_directives GET /LangPHP/php_ini_get_user_basic_directives Return basic PHP directives
PHPSettingsApi php_ini_get_user_content GET /LangPHP/php_ini_get_user_content Return virtual host's php.ini content
PHPSettingsApi php_ini_get_user_paths GET /LangPHP/php_ini_get_user_paths Return php.ini file paths
PHPSettingsApi php_ini_set_user_basic_directives GET /LangPHP/php_ini_set_user_basic_directives Update basic PHP directives
PHPSettingsApi php_ini_set_user_content GET /LangPHP/php_ini_set_user_content Update virtual host's php.ini content
PHPSettingsApi php_set_vhost_versions GET /LangPHP/php_set_vhost_versions Update virtual host's PHP version
ParserApi firstfile_relative_uri GET /Parser/firstfile_relative_uri Return session relative URI
PassengerAppsApi disable_application GET /PassengerApps/disable_application Disable Passenger application
PassengerAppsApi edit_application GET /PassengerApps/edit_application Update Passenger application settings
PassengerAppsApi enable_application GET /PassengerApps/enable_application Enable Passenger application
PassengerAppsApi ensure_deps GET /PassengerApps/ensure_deps Install Passenger application dependencies
PassengerAppsApi list_applications GET /PassengerApps/list_applications Return Passenger applications
PassengerAppsApi register_application GET /PassengerApps/register_application Register Passenger application
PassengerAppsApi unregister_application GET /PassengerApps/unregister_application Unregister Passenger application
PasswdStrengthApi get_required_strength GET /PasswdStrength/get_required_strength Return minimum required password strength
PasswordStrengthApi get_required_strength GET /PasswdStrength/get_required_strength Return minimum required password strength
PersonalizationApi personalization_get POST /Personalization/get Retrieve NVData data from file
PersonalizationApi personalization_set POST /Personalization/set Save NVData data to file
PluginsApi plugins_can_show_promotions GET /Plugins/can_show_promotions Enable plugin promotions
PostgreSQLDatabaseManagementApi postgresql_create_database GET /Postgresql/create_database Create PostgreSQL database
PostgreSQLDatabaseManagementApi postgresql_delete_database GET /Postgresql/delete_database Delete PostgreSQL database
PostgreSQLDatabaseManagementApi postgresql_get_restrictions GET /Postgresql/get_restrictions Return PostgreSQL name length restrictions
PostgreSQLDatabaseManagementApi postgresql_list_databases GET /Postgresql/list_databases Return PostgreSQL databases
PostgreSQLDatabaseManagementApi rename_database GET /Postgresql/rename_database Update PostgreSQL database name
PostgreSQLUserManagementApi create_user GET /Postgresql/create_user Create PostgreSQL user
PostgreSQLUserManagementApi grant_all_privileges GET /Postgresql/grant_all_privileges Enable all user privileges on PostgreSQL database
PostgreSQLUserManagementApi postgresql_delete_user GET /Postgresql/delete_user Delete PostgreSQL user
PostgreSQLUserManagementApi postgresql_list_users GET /Postgresql/list_users Return PostgreSQL users
PostgreSQLUserManagementApi postgresql_rename_user GET /Postgresql/rename_user Update PostgreSQL username
PostgreSQLUserManagementApi postgresql_update_privileges GET /Postgresql/update_privileges Update PostgreSQL® privileges
PostgreSQLUserManagementApi rename_user_no_password GET /Postgresql/rename_user_no_password Update PostgreSQL username without password
PostgreSQLUserManagementApi revoke_all_privileges GET /Postgresql/revoke_all_privileges Remove PostgreSQL user privileges
PostgreSQLUserManagementApi set_password GET /Postgresql/set_password Update PostgreSQL user password
PostgresqlApi create_user GET /Postgresql/create_user Create PostgreSQL user
PostgresqlApi grant_all_privileges GET /Postgresql/grant_all_privileges Enable all user privileges on PostgreSQL database
PostgresqlApi postgresql_create_database GET /Postgresql/create_database Create PostgreSQL database
PostgresqlApi postgresql_delete_database GET /Postgresql/delete_database Delete PostgreSQL database
PostgresqlApi postgresql_delete_user GET /Postgresql/delete_user Delete PostgreSQL user
PostgresqlApi postgresql_get_restrictions GET /Postgresql/get_restrictions Return PostgreSQL name length restrictions
PostgresqlApi postgresql_list_databases GET /Postgresql/list_databases Return PostgreSQL databases
PostgresqlApi postgresql_list_users GET /Postgresql/list_users Return PostgreSQL users
PostgresqlApi postgresql_rename_user GET /Postgresql/rename_user Update PostgreSQL username
PostgresqlApi postgresql_update_privileges GET /Postgresql/update_privileges Update PostgreSQL® privileges
PostgresqlApi rename_database GET /Postgresql/rename_database Update PostgreSQL database name
PostgresqlApi rename_user_no_password GET /Postgresql/rename_user_no_password Update PostgreSQL username without password
PostgresqlApi revoke_all_privileges GET /Postgresql/revoke_all_privileges Remove PostgreSQL user privileges
PostgresqlApi set_password GET /Postgresql/set_password Update PostgreSQL user password
PushbulletApi send_test_message GET /Pushbullet/send_test_message Validate Pushbullet token
QuotaApi get_local_quota_info GET /Quota/get_local_quota_info Return local disk quota information
QuotaApi get_quota_info GET /Quota/get_quota_info Return disk quota information
RemoteDatabasesApi add_host GET /Mysql/add_host Enable remote MySQL host access
RemoteDatabasesApi delete_host GET /Mysql/delete_host Disable remote MySQL host access
RemoteDatabasesApi get_host_notes GET /Mysql/get_host_notes Return remote MySQL host notes
RemoteDatabasesApi mysql_add_host_note GET /Mysql/add_host_note Add remote MySQL host note
RepositoryManagementApi version_control_create GET /VersionControl/create Create Git repository
RepositoryManagementApi version_control_delete GET /VersionControl/delete Delete Git repository
RepositoryManagementApi version_control_retrieve GET /VersionControl/retrieve Return Git repositories
RepositoryManagementApi version_control_update GET /VersionControl/update Update Git repository settings
ResellersApi list_accounts GET /Resellers/list_accounts Return reseller's cPanel accounts
ResourceUsageApi get_usages GET /ResourceUsage/get_usages Return resource usage and custom statistics
ResourceUsageAndStatisticsApi get_stats GET /StatsBar/get_stats Return cPanel account statistics
ResourceUsageAndStatisticsApi get_usages GET /ResourceUsage/get_usages Return resource usage and custom statistics
SNIEmailSettingsApi disable_mail_sni GET /SSL/disable_mail_sni Disable SNI mail services for domain
SNIEmailSettingsApi enable_mail_sni GET /SSL/enable_mail_sni Enable SNI mail services for domain
SNIEmailSettingsApi is_mail_sni_supported GET /SSL/is_mail_sni_supported Return whether mail SNI is enabled
SNIEmailSettingsApi is_sni_supported GET /SSL/is_sni_supported Return whether Apache web server supports mail SNI
SNIEmailSettingsApi mail_sni_status GET /SSL/mail_sni_status Return status of domain's SNI mail services
SNIEmailSettingsApi rebuild_mail_sni_config GET /SSL/rebuild_mail_sni_config Start SNI configuration files rebuild
SSETaskManagementApi retrieve GET /UserTasks/retrieve Return task queue information
SSETaskManagementApi user_tasks_delete GET /UserTasks/delete Remove item from task queue
SSHApi s_sh_get_port GET /SSH/get_port Return SSH port
SSLApi add_autossl_excluded_domains GET /SSL/add_autossl_excluded_domains Disable AutoSSL for domains
SSLApi can_ssl_redirect GET /SSL/can_ssl_redirect Return whether domains can redirect to secure URL
SSLApi check_shared_cert GET /SSL/check_shared_cert Return whether shared SSL certificate exists
SSLApi delete_cert GET /SSL/delete_cert Delete SSL certificate
SSLApi delete_csr GET /SSL/delete_csr Delete certificate signing request
SSLApi delete_key GET /SSL/delete_key Delete private key
SSLApi delete_ssl GET /SSL/delete_ssl Remove SSL for domain
SSLApi disable_mail_sni GET /SSL/disable_mail_sni Disable SNI mail services for domain
SSLApi enable_mail_sni GET /SSL/enable_mail_sni Enable SNI mail services for domain
SSLApi fetch_best_for_domain GET /SSL/fetch_best_for_domain Request best SSL certificate
SSLApi fetch_cert_info GET /SSL/fetch_cert_info Return SSL certificate information
SSLApi fetch_certificates_for_fqdns GET /SSL/fetch_certificates_for_fqdns Return SSL certificate information for all FQDN
SSLApi fetch_key_and_cabundle_for_certificate POST /SSL/fetch_key_and_cabundle_for_certificate Return private key and CA bundle
SSLApi find_certificates_for_key GET /SSL/find_certificates_for_key Return SSL certificate for private key
SSLApi find_csrs_for_key GET /SSL/find_csrs_for_key Return private key's certificate signing requests
SSLApi generate_cert GET /SSL/generate_cert Create self-signed SSL certificate
SSLApi generate_csr GET /SSL/generate_csr Create certificate signing request
SSLApi get_autossl_excluded_domains GET /SSL/get_autossl_excluded_domains Return AutoSSL disabled domains
SSLApi get_autossl_problems GET /SSL/get_autossl_problems Return domains with AutoSSL problems
SSLApi get_cabundle GET /SSL/get_cabundle Return certificate's CA bundle and hostname
SSLApi get_cn_name GET /SSL/get_cn_name Request best SSL domain for service
SSLApi install_ssl GET /SSL/install_ssl Install SSL certificate
SSLApi installed_host GET /SSL/installed_host Return SSL certificate's info for dedicated IP
SSLApi installed_hosts GET /SSL/installed_hosts Return domains with SSL certificate information
SSLApi is_autossl_check_in_progress GET /SSL/is_autossl_check_in_progress Return whether AutoSSL check in progress
SSLApi is_mail_sni_supported GET /SSL/is_mail_sni_supported Return whether mail SNI is enabled
SSLApi is_sni_supported GET /SSL/is_sni_supported Return whether Apache web server supports mail SNI
SSLApi list_certs GET /SSL/list_certs Return all SSL certificates
SSLApi list_csrs GET /SSL/list_csrs Return all certificate signing requests
SSLApi list_keys GET /SSL/list_keys Return all private keys
SSLApi list_ssl_items GET /SSL/list_ssl_items Return SSL-related items
SSLApi mail_sni_status GET /SSL/mail_sni_status Return status of domain's SNI mail services
SSLApi rebuild_mail_sni_config GET /SSL/rebuild_mail_sni_config Start SNI configuration files rebuild
SSLApi rebuildssldb GET /SSL/rebuildssldb Start SSL database rebuild
SSLApi remove_autossl_excluded_domains GET /SSL/remove_autossl_excluded_domains Enable AutoSSL for specifed domains
SSLApi s_sl_generate_key GET /SSL/generate_key Create private key
SSLApi s_sl_set_default_key_type GET /SSL/set_default_key_type Update SSL TLS key type
SSLApi set_autossl_excluded_domains GET /SSL/set_autossl_excluded_domains Disable AutoSSL for specifed domains
SSLApi set_cert_friendly_name GET /SSL/set_cert_friendly_name Update SSL certificate's friendly name
SSLApi set_csr_friendly_name GET /SSL/set_csr_friendly_name Update certificate signing request's friendly name
SSLApi set_key_friendly_name GET /SSL/set_key_friendly_name Update private key's friendly name
SSLApi set_primary_ssl GET /SSL/set_primary_ssl Update SSL website for dedicated IP address
SSLApi show_cert GET /SSL/show_cert Export SSL certificate
SSLApi show_csr GET /SSL/show_csr Export certificate signing request
SSLApi show_key GET /SSL/show_key Export private key
SSLApi start_autossl_check GET /SSL/start_autossl_check Start AutoSSL for current user
SSLApi toggle_ssl_redirect_for_domains GET /SSL/toggle_ssl_redirect_for_domains Enable or disable secure redirects
SSLApi upload_cert POST /SSL/upload_cert Import SSL certificate
SSLApi upload_key POST /SSL/upload_key Import private key
SSLCertificateManagementApi delete_cert GET /SSL/delete_cert Delete SSL certificate
SSLCertificateManagementApi delete_csr GET /SSL/delete_csr Delete certificate signing request
SSLCertificateManagementApi delete_key GET /SSL/delete_key Delete private key
SSLCertificateManagementApi generate_cert GET /SSL/generate_cert Create self-signed SSL certificate
SSLCertificateManagementApi generate_csr GET /SSL/generate_csr Create certificate signing request
SSLCertificateManagementApi install_ssl GET /SSL/install_ssl Install SSL certificate
SSLCertificateManagementApi s_sl_generate_key GET /SSL/generate_key Create private key
SSLCertificateManagementApi set_cert_friendly_name GET /SSL/set_cert_friendly_name Update SSL certificate's friendly name
SSLCertificateManagementApi set_csr_friendly_name GET /SSL/set_csr_friendly_name Update certificate signing request's friendly name
SSLCertificateManagementApi set_key_friendly_name GET /SSL/set_key_friendly_name Update private key's friendly name
SSLCertificateManagementApi set_primary_ssl GET /SSL/set_primary_ssl Update SSL website for dedicated IP address
SSLCertificateManagementApi show_cert GET /SSL/show_cert Export SSL certificate
SSLCertificateManagementApi show_csr GET /SSL/show_csr Export certificate signing request
SSLCertificateManagementApi show_key GET /SSL/show_key Export private key
SSLCertificateManagementApi upload_cert POST /SSL/upload_cert Import SSL certificate
SSLCertificateManagementApi upload_key POST /SSL/upload_key Import private key
SSLCertificatesApi cancel_pending_ssl_certificate GET /Market/cancel_pending_ssl_certificate Delete an order
SSLCertificatesApi get_certificate_status_details GET /Market/get_certificate_status_details Return provider's SSL certificate request status
SSLCertificatesApi get_pending_ssl_certificates GET /Market/get_pending_ssl_certificates Return provider's pending SSL certificates
SSLCertificatesApi get_ssl_certificate_if_available GET /Market/get_ssl_certificate_if_available Return provider's available SSL certificates
SSLCertificatesApi market_get_provider_specific_dcv_constraints GET /Market/get_provider_specific_dcv_constraints Return provider's DCV filename requirements
SSLCertificatesApi process_ssl_pending_queue GET /Market/process_ssl_pending_queue Start processing pending queue's SSL certificates
SSLCertificatesApi request_ssl_certificates GET /Market/request_ssl_certificates Request SSL certificate order
ServerInformationApi get_information GET /ServerInformation/get_information Return service and device status
ServiceProxyApi serviceproxy_get_service_proxy_backends GET /ServiceProxy/get_service_proxy_backends Return a cPanel account’s service proxying setup
ServiceProxyApi serviceproxy_set_service_proxy_backends GET /ServiceProxy/set_service_proxy_backends Add cPanel account service proxying
ServiceProxyApi serviceproxy_unset_all_service_proxy_backends GET /ServiceProxy/unset_all_service_proxy_backends Remove cPanel account service proxying
SessionApi create_temp_user GET /Session/create_temp_user Create user session with existing session
SessionApi create_webmail_session_for_mail_user GET /Session/create_webmail_session_for_mail_user Create Webmail session
SessionApi create_webmail_session_for_mail_user_check_password GET /Session/create_webmail_session_for_mail_user_check_password Create Webmail session with credentials
SessionApi create_webmail_session_for_self GET /Session/create_webmail_session_for_self Create Webmail session for current user
SigningAndEncryptionGnuPGKeysApi delete_keypair GET /GPG/delete_keypair Delete GnuPG key pair
SigningAndEncryptionGnuPGKeysApi export_public_key GET /GPG/export_public_key Export GnuPG public key
SigningAndEncryptionGnuPGKeysApi export_secret_key GET /GPG/export_secret_key Export GnuPG secret key
SigningAndEncryptionGnuPGKeysApi generate_key GET /GPG/generate_key Create GnuPG key
SigningAndEncryptionGnuPGKeysApi import_key GET /GPG/import_key Import GnuPG key
SigningAndEncryptionGnuPGKeysApi list_public_keys GET /GPG/list_public_keys Return current user's GnuPG public keys
SigningAndEncryptionGnuPGKeysApi list_secret_keys GET /GPG/list_secret_keys Return current user's GnuPG secret keys
SiteQualityApi site_quality_create_project POST /SiteQuality/create_project Add domain to monitoring
SiteQualityApi site_quality_create_site_quality_user POST /SiteQuality/create_site_quality_user Register cPanel user for monitoring
SiteQualityApi site_quality_delete_site_quality_user GET /SiteQuality/delete_site_quality_user Delete Site Quality Monitoring account
SiteQualityApi site_quality_get_all_scores POST /SiteQuality/get_all_scores Return all projects' monitoring results
SiteQualityApi site_quality_get_app_token GET /SiteQuality/get_app_token Return koality authentication token
SiteQualityApi site_quality_has_site_quality_user GET /SiteQuality/has_site_quality_user Validate monitoring account existence
SiteQualityApi site_quality_is_site_quality_user_enabled GET /SiteQuality/is_site_quality_user_enabled Validate monitoring account enablement
SiteQualityApi site_quality_reset_config GET /SiteQuality/reset_config Remove monitoring user from cPanel configuration
SiteQualityApi site_quality_send_activation_email GET /SiteQuality/send_activation_email Request activation email
SiteQualityApi site_quality_verify_code GET /SiteQuality/verify_code Validate activation code
SiteTemplatesApi list_site_templates GET /SiteTemplates/list_site_templates Return available Site Publisher templates
SiteTemplatesApi list_user_settings GET /SiteTemplates/list_user_settings Return Site Publisher websites' information
SiteTemplatesApi publish GET /SiteTemplates/publish Add Site Publisher website
SiteInformationApi word_press_site_retrieve GET /WordPressSite/retrieve Return WordPress site information
SiteInstallationApi word_press_site_create GET /WordPressSite/create Install WordPress site
SitePublisherManagementApi list_site_templates GET /SiteTemplates/list_site_templates Return available Site Publisher templates
SitePublisherManagementApi list_user_settings GET /SiteTemplates/list_user_settings Return Site Publisher websites' information
SitePublisherManagementApi publish GET /SiteTemplates/publish Add Site Publisher website
SitejetApi add_sitejet_api_token GET /Sitejet/add_api_token Add an existing Sitejet API token.
SitejetApi create_restore_point GET /Sitejet/create_restore_point Create a restore point.
SitejetApi create_sitejet_account GET /Sitejet/create_account Generate a Sitejet API key.
SitejetApi create_sitejet_website GET /Sitejet/create_website Create Sitejet domain ID
SitejetApi get_all_user_sitejet_info GET /Sitejet/get_all_user_sitejet_info Return Sitejet domains
SitejetApi get_sitejet_api_token GET /Sitejet/get_api_token Return Sitejet API token
SitejetApi get_sitejet_preview_url GET /Sitejet/get_preview_url Return Sitejet preview URL
SitejetApi get_sitejet_sso_link GET /Sitejet/get_sso_link Return Sitejet SSO URL
SitejetApi get_sitejet_templates GET /Sitejet/get_templates Return Sitejet templates
SitejetApi restore_document_root GET /Sitejet/restore_document_root Restore a domain from the restore point.
SitejetApi set_sitejet_template GET /Sitejet/set_template Update Sitejet template
SitejetApi start_publish_sitejet GET /Sitejet/start_publish Publish Sitejet domain
SpamAssassinApi clear_spam_box GET /SpamAssassin/clear_spam_box Delete spam box contents
SpamAssassinApi get_symbolic_test_names GET /SpamAssassin/get_symbolic_test_names Return SpamAssassin™ symbolic test scores
SpamAssassinApi get_user_preferences GET /SpamAssassin/get_user_preferences Return SpamAssassin™ settings
SpamAssassinApi update_user_preference GET /SpamAssassin/update_user_preference Update SpamAssassin™ settings
SpamFilteringGreylistingApi c_p_grey_list_disable_all_domains GET /cPGreyList/disable_all_domains Disable Greylisting for all domains
SpamFilteringGreylistingApi c_p_grey_list_disable_domains GET /cPGreyList/disable_domains Disable Greylisting for specified domains
SpamFilteringGreylistingApi c_p_grey_list_enable_all_domains GET /cPGreyList/enable_all_domains Enable Greylisting for all domains
SpamFilteringGreylistingApi c_p_grey_list_enable_domains GET /cPGreyList/enable_domains Enable Greylisting for specified domains
SpamFilteringGreylistingApi c_p_grey_list_list_domains GET /cPGreyList/list_domains Return Greylisting status for domains
SpamFilteringGreylistingApi has_greylisting_enabled GET /cPGreyList/has_greylisting_enabled Return whether Greylisting is enabled
SpamManagementApi add_spam_filter GET /Email/add_spam_filter Update minimum spam score threshold value
SpamManagementApi clear_spam_box GET /SpamAssassin/clear_spam_box Delete spam box contents
SpamManagementApi disable_spam_assassin GET /Email/disable_spam_assassin Disable Apache SpamAssassin for cPanel account
SpamManagementApi disable_spam_autodelete GET /Email/disable_spam_autodelete Disable spam box filtering auto-delete
SpamManagementApi disable_spam_box GET /Email/disable_spam_box Disable spam box filtering for cPanel account
SpamManagementApi enable_spam_assassin GET /Email/enable_spam_assassin Enable Apache SpamAssassin for cPanel account
SpamManagementApi enable_spam_box GET /Email/enable_spam_box Enable spam box filtering for cPanel account
SpamManagementApi get_spam_settings GET /Email/get_spam_settings Return email account Apache SpamAssassin settings
SpamManagementApi get_symbolic_test_names GET /SpamAssassin/get_symbolic_test_names Return SpamAssassin™ symbolic test scores
SpamManagementApi get_user_preferences GET /SpamAssassin/get_user_preferences Return SpamAssassin™ settings
SpamManagementApi update_user_preference GET /SpamAssassin/update_user_preference Update SpamAssassin™ settings
SpamPreventionBoxTrapperApi blacklist_messages GET /BoxTrapper/blacklist_messages Add email address to BoxTrapper blocked senders
SpamPreventionBoxTrapperApi box_trapper_get_allowlist GET /BoxTrapper/get_allowlist Return account BoxTrapper allowlist rules
SpamPreventionBoxTrapperApi box_trapper_get_blocklist GET /BoxTrapper/get_blocklist Return account BoxTrapper blocklist rules
SpamPreventionBoxTrapperApi box_trapper_get_ignorelist GET /BoxTrapper/get_ignorelist Return account BoxTrapper ignorelist rules
SpamPreventionBoxTrapperApi box_trapper_set_allowlist GET /BoxTrapper/set_allowlist Update account BoxTrapper allowlist
SpamPreventionBoxTrapperApi box_trapper_set_blocklist GET /BoxTrapper/set_blocklist Update account BoxTrapper blocklist
SpamPreventionBoxTrapperApi box_trapper_set_ignorelist GET /BoxTrapper/set_ignorelist Update account BoxTrapper ignorelist
SpamPreventionBoxTrapperApi delete_messages GET /BoxTrapper/delete_messages Delete messages in the BoxTrapper queue
SpamPreventionBoxTrapperApi deliver_messages GET /BoxTrapper/deliver_messages Send messages in the BoxTrapper queue
SpamPreventionBoxTrapperApi get_configuration GET /BoxTrapper/get_configuration Return email account's BoxTrapper configuration
SpamPreventionBoxTrapperApi get_email_template GET /BoxTrapper/get_email_template Return specified BoxTrapper email template
SpamPreventionBoxTrapperApi get_forwarders GET /BoxTrapper/get_forwarders Return all BoxTrapper forwarders
SpamPreventionBoxTrapperApi get_log GET /BoxTrapper/get_log Return BoxTrapper log file and contents
SpamPreventionBoxTrapperApi get_message GET /BoxTrapper/get_message Return message's top 200 lines in BoxTrapper queue
SpamPreventionBoxTrapperApi get_status GET /BoxTrapper/get_status Return whether email account uses BoxTrapper
SpamPreventionBoxTrapperApi ignore_messages GET /BoxTrapper/ignore_messages Add email account to Exim ignore list
SpamPreventionBoxTrapperApi list_email_templates GET /BoxTrapper/list_email_templates Return BoxTrapper email templates
SpamPreventionBoxTrapperApi list_queued_messages GET /BoxTrapper/list_queued_messages Return email account's BoxTrapper queued messages
SpamPreventionBoxTrapperApi process_messages GET /BoxTrapper/process_messages Run a specific BoxTrapper action for a message
SpamPreventionBoxTrapperApi reset_email_template GET /BoxTrapper/reset_email_template Restore default BoxTrapper email message template
SpamPreventionBoxTrapperApi save_configuration GET /BoxTrapper/save_configuration Update email account's BoxTrapper configuration
SpamPreventionBoxTrapperApi save_email_template GET /BoxTrapper/save_email_template Save BoxTrapper message template contents
SpamPreventionBoxTrapperApi set_forwarders GET /BoxTrapper/set_forwarders Add email address to BoxTrapper forwarders
SpamPreventionBoxTrapperApi set_status GET /BoxTrapper/set_status Enable or disable BoxTrapper for email account
SpamPreventionBoxTrapperApi whitelist_messages GET /BoxTrapper/whitelist_messages Add email address to BoxTrapper allowed senders
StatsApi get_bandwidth GET /Stats/get_bandwidth Return bandwidth statistics for all domains
StatsApi get_site_errors GET /Stats/get_site_errors Return specified domain access log
StatsApi list_sites GET /Stats/list_sites Return Analog statistics for all domains
StatsApi list_stats_by_domain GET /Stats/list_stats_by_domain Return Analog statistics for specified domain
StatsBarApi get_stats GET /StatsBar/get_stats Return cPanel account statistics
StatsManagerApi stats_manager_get_configuration GET /StatsManager/get_configuration Returns weblog analyzers' configuration
StatsManagerApi stats_manager_save_configuration POST /StatsManager/save_configuration Save current user's weblog analyzers configuration
SubDomainApi addsubdomain GET /SubDomain/addsubdomain Create subdomain
SubaccountManagementApi check_account_conflicts GET /UserManager/check_account_conflicts Return Subaccounts and service accounts conflicts
SubaccountManagementApi dismiss_merge GET /UserManager/dismiss_merge Remove service account link request
SubaccountManagementApi edit_user GET /UserManager/edit_user Update Subaccount settings
SubaccountManagementApi lookup_service_account GET /UserManager/lookup_service_account Return service account's information
SubaccountManagementApi lookup_user GET /UserManager/lookup_user Return Subaccount's information
SubaccountManagementApi merge_service_account GET /UserManager/merge_service_account Register service account to Subaccount
SubaccountManagementApi unlink_service_account GET /UserManager/unlink_service_account Unregister service account from Subaccount
SubaccountManagementApi user_manager_create_user GET /UserManager/create_user Create Subaccount
SubaccountManagementApi user_manager_delete_user GET /UserManager/delete_user Delete Subaccount
SubaccountManagementApi user_manager_list_users GET /UserManager/list_users Return cPanel account's Subaccounts
TeamRolesApi list_feature_descriptions GET /TeamRoles/list_feature_descriptions List all role feature descriptions
TeamUsersApi add_roles GET /Team/add_roles Add roles to a team user
TeamUsersApi add_team_user GET /Team/add_team_user Add a team user
TeamUsersApi cancel_expire GET /Team/cancel_expire Stop a team user from expiring
TeamUsersApi edit_team_user GET /Team/edit_team_user Edit a team user
TeamUsersApi get_team_users_with_roles_count GET /Team/get_team_users_with_roles_count Get number of team users with roles
TeamUsersApi list_team GET /Team/list_team List Team Users
TeamUsersApi password_reset_request GET /Team/password_reset_request Sends a password reset request link to team user.
TeamUsersApi reinstate_team_user GET /Team/reinstate_team_user Reinstate a team user
TeamUsersApi remove_roles GET /Team/remove_roles Remove roles from a team user
TeamUsersApi remove_team_user GET /Team/remove_team_user Remove a team user
TeamUsersApi set_expire GET /Team/set_expire Set a team user to expire
TeamUsersApi set_roles GET /Team/set_roles Set roles for a team user
TeamUsersApi set_team_user_contact_email GET /Team/set_contact_email Set a contact email address for a team user
TeamUsersApi set_team_user_notes GET /Team/set_notes Set notes for a team user
TeamUsersApi set_team_user_password GET /Team/set_password Set password for a team user
TeamUsersApi suspend_team_user GET /Team/suspend_team_user Suspend a team user
TeamUsersApi team_set_locale GET /Team/set_locale Set locale for a team user
ThemeSettingsApi get_theme_base GET /Themes/get_theme_base Return current theme
ThemeSettingsApi themes_list GET /Themes/list Return available themes
ThemeSettingsApi themes_update GET /Themes/update Update current theme
ThemesApi get_theme_base GET /Themes/get_theme_base Return current theme
ThemesApi themes_list GET /Themes/list Return available themes
ThemesApi themes_update GET /Themes/update Update current theme
TokensApi create_full_access GET /Tokens/create_full_access Create cPanel API token
TokensApi rename GET /Tokens/rename Update cPanel API token's name
TokensApi revoke GET /Tokens/revoke Remove cPanel API token
TokensApi tokens_list GET /Tokens/list Return cPanel API tokens
TwoFactorAuthApi generate_user_configuration GET /TwoFactorAuth/generate_user_configuration Create 2FA authentication code
TwoFactorAuthApi get_team_user_configuration GET /TwoFactorAuth/get_team_user_configuration Return team user 2FA config
TwoFactorAuthApi get_user_configuration GET /TwoFactorAuth/get_user_configuration Return cPanel account 2FA config
TwoFactorAuthApi remove_user_configuration GET /TwoFactorAuth/remove_user_configuration Remove 2FA config
TwoFactorAuthApi set_user_configuration GET /TwoFactorAuth/set_user_configuration Save 2FA config
TwoFactorSettingsApi generate_user_configuration GET /TwoFactorAuth/generate_user_configuration Create 2FA authentication code
TwoFactorSettingsApi get_team_user_configuration GET /TwoFactorAuth/get_team_user_configuration Return team user 2FA config
TwoFactorSettingsApi get_user_configuration GET /TwoFactorAuth/get_user_configuration Return cPanel account 2FA config
TwoFactorSettingsApi remove_user_configuration GET /TwoFactorAuth/remove_user_configuration Remove 2FA config
TwoFactorSettingsApi set_user_configuration GET /TwoFactorAuth/set_user_configuration Save 2FA config
URLParsingApi fetch_url GET /Integration/fetch_url Return integrated application URL
URLParsingApi firstfile_relative_uri GET /Parser/firstfile_relative_uri Return session relative URI
UserManagerApi change_password GET /UserManager/change_password Update cPanel account password
UserManagerApi check_account_conflicts GET /UserManager/check_account_conflicts Return Subaccounts and service accounts conflicts
UserManagerApi dismiss_merge GET /UserManager/dismiss_merge Remove service account link request
UserManagerApi edit_user GET /UserManager/edit_user Update Subaccount settings
UserManagerApi lookup_service_account GET /UserManager/lookup_service_account Return service account's information
UserManagerApi lookup_user GET /UserManager/lookup_user Return Subaccount's information
UserManagerApi merge_service_account GET /UserManager/merge_service_account Register service account to Subaccount
UserManagerApi unlink_service_account GET /UserManager/unlink_service_account Unregister service account from Subaccount
UserManagerApi user_manager_create_user GET /UserManager/create_user Create Subaccount
UserManagerApi user_manager_delete_user GET /UserManager/delete_user Delete Subaccount
UserManagerApi user_manager_list_users GET /UserManager/list_users Return cPanel account's Subaccounts
UserTasksApi retrieve GET /UserTasks/retrieve Return task queue information
UserTasksApi user_tasks_delete GET /UserTasks/delete Remove item from task queue
UserManagementApi get_restrictions GET /Mysql/get_restrictions Return MySQL name length restrictions
UserManagementApi list_routines GET /Mysql/list_routines Return MySQL user routines
UserManagementApi mysql_create_user GET /Mysql/create_user Create MySQL user
UserManagementApi mysql_delete_user GET /Mysql/delete_user Delete MySQL user
UserManagementApi mysql_get_privileges_on_database GET /Mysql/get_privileges_on_database Return MySQL user privileges
UserManagementApi mysql_list_users GET /Mysql/list_users Return MySQL users
UserManagementApi mysql_set_password GET /Mysql/set_password Update MySQL user password
UserManagementApi rename_user GET /Mysql/rename_user Update MySQL username
UserManagementApi revoke_access_to_database GET /Mysql/revoke_access_to_database Remove MySQL user privileges
UserManagementApi set_privileges_on_database GET /Mysql/set_privileges_on_database Update MySQL user privileges
VariablesApi get_session_information GET /Variables/get_session_information Return web server's hostname
VariablesApi variables_get_server_information GET /Variables/get_server_information Return server's configuration settings
VariablesApi variables_get_user_information GET /Variables/get_user_information Return cPanel account's configuration settings
VerifyDomainOwnershipApi check_domains_via_dns POST /DCV/check_domains_via_dns Verify domain ownership via DNS
VerifyDomainOwnershipApi check_domains_via_http GET /DCV/check_domains_via_http Verify domain ownership via HTTP
VerifyDomainOwnershipApi ensure_domains_can_pass_dcv GET /DCV/ensure_domains_can_pass_dcv Verify domain ownership
VersionControlApi version_control_create GET /VersionControl/create Create Git repository
VersionControlApi version_control_delete GET /VersionControl/delete Delete Git repository
VersionControlApi version_control_retrieve GET /VersionControl/retrieve Return Git repositories
VersionControlApi version_control_update GET /VersionControl/update Update Git repository settings
VersionControlDeploymentApi delete GET /VersionControlDeployment/delete Delete Git deployment task
VersionControlDeploymentApi version_control_deployment_create GET /VersionControlDeployment/create Create Git deployment task
VersionControlDeploymentApi version_control_deployment_retrieve GET /VersionControlDeployment/retrieve Return Git deployment task status
VirtualHostInformationApi list_ssl_capable_domains GET /WebVhosts/list_ssl_capable_domains Return domains that allow SSL certificate purchase
VirtualHostInformationApi web_vhosts_list_domains GET /WebVhosts/list_domains Return virtual host names for domains
WebDiskApi set_permissions GET /WebDisk/set_permissions Update Web Disk home directory permissions
WebDiskApi web_disk_delete_user GET /WebDisk/delete_user Delete Web Disk account
WebDiskApi web_disk_set_homedir GET /WebDisk/set_homedir Update Web Disk home directory location
WebDiskApi web_disk_set_password GET /WebDisk/set_password Update Web Disk account password
WebDiskSettingsApi set_permissions GET /WebDisk/set_permissions Update Web Disk home directory permissions
WebDiskSettingsApi web_disk_delete_user GET /WebDisk/delete_user Delete Web Disk account
WebDiskSettingsApi web_disk_set_homedir GET /WebDisk/set_homedir Update Web Disk home directory location
WebDiskSettingsApi web_disk_set_password GET /WebDisk/set_password Update Web Disk account password
WebVhostsApi list_ssl_capable_domains GET /WebVhosts/list_ssl_capable_domains Return domains that allow SSL certificate purchase
WebVhostsApi web_vhosts_list_domains GET /WebVhosts/list_domains Return virtual host names for domains
WeblogSettingsApi stats_manager_get_configuration GET /StatsManager/get_configuration Returns weblog analyzers' configuration
WeblogSettingsApi stats_manager_save_configuration POST /StatsManager/save_configuration Save current user's weblog analyzers configuration
WebmailAppsApi list_webmail_apps GET /WebmailApps/list_webmail_apps Return available webmail clients
WebmailApplicationsApi list_webmail_apps GET /WebmailApps/list_webmail_apps Return available webmail clients
WebmailSessionsApi create_temp_user GET /Session/create_temp_user Create user session with existing session
WebmailSessionsApi create_webmail_session_for_mail_user GET /Session/create_webmail_session_for_mail_user Create Webmail session
WebmailSessionsApi create_webmail_session_for_mail_user_check_password GET /Session/create_webmail_session_for_mail_user_check_password Create Webmail session with credentials
WebmailSessionsApi create_webmail_session_for_self GET /Session/create_webmail_session_for_self Create Webmail session for current user
WordPressBackupApi any_running GET /WordPressBackup/any_running Return all WordPress sites' backup status
WordPressBackupApi cancel GET /WordPressBackup/cancel Stop WordPress site backup
WordPressBackupApi cleanup GET /WordPressBackup/cleanup Delete WordPress backup temporary files
WordPressBackupApi get_available_backups GET /WordPressBackup/get_available_backups Return WordPress site backups
WordPressBackupApi is_running GET /WordPressBackup/is_running Return WordPress site backup status
WordPressBackupApi start GET /WordPressBackup/start Backup WordPress site
WordPressInstanceManagerApi cancel_scan GET /WordPressInstanceManager/cancel_scan Stop WordPress site scan
WordPressInstanceManagerApi change_admin_password GET /WordPressInstanceManager/change_admin_password Update WordPress site admin password
WordPressInstanceManagerApi cleanup_scan GET /WordPressInstanceManager/cleanup_scan Remove scan log after completed scan
WordPressInstanceManagerApi configure_autoupdate GET /WordPressInstanceManager/configure_autoupdate Update WordPress site automatic update settings
WordPressInstanceManagerApi get_api_version GET /WordPressInstanceManager/get_api_version Return WordPress Manager plugin version
WordPressInstanceManagerApi get_instance_by_id GET /WordPressInstanceManager/get_instance_by_id Return WordPress site settings
WordPressInstanceManagerApi get_instances GET /WordPressInstanceManager/get_instances Return WordPress sites
WordPressInstanceManagerApi get_latest_wordpress_version_from_wordpress_org GET /WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org Return latest wordpress.org updates
WordPressInstanceManagerApi get_scan_results GET /WordPressInstanceManager/get_scan_results Return WordPress site scan results
WordPressInstanceManagerApi is_installable_addon_available GET /WordPressInstanceManager/is_installable_addon_available Verify WordPress cPAddon availability
WordPressInstanceManagerApi word_press_instance_manager_start_scan GET /WordPressInstanceManager/start_scan Start WordPress sites scan
WordPressRestoreApi word_press_restore_any_running GET /WordPressRestore/any_running Return WordPress site restore status
WordPressRestoreApi word_press_restore_cleanup GET /WordPressRestore/cleanup Delete restored WordPress site's temporary files
WordPressRestoreApi word_press_restore_start GET /WordPressRestore/start Restore WordPress site
WordPressSiteApi word_press_site_create GET /WordPressSite/create Install WordPress site
WordPressSiteApi word_press_site_retrieve GET /WordPressSite/retrieve Return WordPress site information
WordPressManagerBackupsApi any_running GET /WordPressBackup/any_running Return all WordPress sites' backup status
WordPressManagerBackupsApi cancel GET /WordPressBackup/cancel Stop WordPress site backup
WordPressManagerBackupsApi cleanup GET /WordPressBackup/cleanup Delete WordPress backup temporary files
WordPressManagerBackupsApi get_available_backups GET /WordPressBackup/get_available_backups Return WordPress site backups
WordPressManagerBackupsApi is_running GET /WordPressBackup/is_running Return WordPress site backup status
WordPressManagerBackupsApi start GET /WordPressBackup/start Backup WordPress site
WordPressManagerBackupsApi word_press_restore_any_running GET /WordPressRestore/any_running Return WordPress site restore status
WordPressManagerBackupsApi word_press_restore_cleanup GET /WordPressRestore/cleanup Delete restored WordPress site's temporary files
WordPressManagerBackupsApi word_press_restore_start GET /WordPressRestore/start Restore WordPress site
WordPressManagerSettingsApi cancel_scan GET /WordPressInstanceManager/cancel_scan Stop WordPress site scan
WordPressManagerSettingsApi change_admin_password GET /WordPressInstanceManager/change_admin_password Update WordPress site admin password
WordPressManagerSettingsApi cleanup_scan GET /WordPressInstanceManager/cleanup_scan Remove scan log after completed scan
WordPressManagerSettingsApi configure_autoupdate GET /WordPressInstanceManager/configure_autoupdate Update WordPress site automatic update settings
WordPressManagerSettingsApi get_api_version GET /WordPressInstanceManager/get_api_version Return WordPress Manager plugin version
WordPressManagerSettingsApi get_instance_by_id GET /WordPressInstanceManager/get_instance_by_id Return WordPress site settings
WordPressManagerSettingsApi get_instances GET /WordPressInstanceManager/get_instances Return WordPress sites
WordPressManagerSettingsApi get_latest_wordpress_version_from_wordpress_org GET /WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org Return latest wordpress.org updates
WordPressManagerSettingsApi get_scan_results GET /WordPressInstanceManager/get_scan_results Return WordPress site scan results
WordPressManagerSettingsApi is_installable_addon_available GET /WordPressInstanceManager/is_installable_addon_available Verify WordPress cPAddon availability
WordPressManagerSettingsApi word_press_instance_manager_start_scan GET /WordPressInstanceManager/start_scan Start WordPress sites scan
CPAddonsApi get_available_addons GET /cPAddons/get_available_addons Return available cPAddons
CPAddonsApi get_instance_settings GET /cPAddons/get_instance_settings Return deployed cPAddons instance's settings
CPAddonsApi list_addon_instances GET /cPAddons/list_addon_instances Return deployed cPAddons instances
CPGreyListApi c_p_grey_list_disable_all_domains GET /cPGreyList/disable_all_domains Disable Greylisting for all domains
CPGreyListApi c_p_grey_list_disable_domains GET /cPGreyList/disable_domains Disable Greylisting for specified domains
CPGreyListApi c_p_grey_list_enable_all_domains GET /cPGreyList/enable_all_domains Enable Greylisting for all domains
CPGreyListApi c_p_grey_list_enable_domains GET /cPGreyList/enable_domains Enable Greylisting for specified domains
CPGreyListApi c_p_grey_list_list_domains GET /cPGreyList/list_domains Return Greylisting status for domains
CPGreyListApi has_greylisting_enabled GET /cPGreyList/has_greylisting_enabled Return whether Greylisting is enabled
CPanelAccountSSLManagementApi can_ssl_redirect GET /SSL/can_ssl_redirect Return whether domains can redirect to secure URL
CPanelAccountSSLManagementApi check_shared_cert GET /SSL/check_shared_cert Return whether shared SSL certificate exists
CPanelAccountSSLManagementApi delete_ssl GET /SSL/delete_ssl Remove SSL for domain
CPanelAccountSSLManagementApi fetch_best_for_domain GET /SSL/fetch_best_for_domain Request best SSL certificate
CPanelAccountSSLManagementApi fetch_cert_info GET /SSL/fetch_cert_info Return SSL certificate information
CPanelAccountSSLManagementApi fetch_certificates_for_fqdns GET /SSL/fetch_certificates_for_fqdns Return SSL certificate information for all FQDN
CPanelAccountSSLManagementApi fetch_key_and_cabundle_for_certificate POST /SSL/fetch_key_and_cabundle_for_certificate Return private key and CA bundle
CPanelAccountSSLManagementApi find_certificates_for_key GET /SSL/find_certificates_for_key Return SSL certificate for private key
CPanelAccountSSLManagementApi find_csrs_for_key GET /SSL/find_csrs_for_key Return private key's certificate signing requests
CPanelAccountSSLManagementApi get_cabundle GET /SSL/get_cabundle Return certificate's CA bundle and hostname
CPanelAccountSSLManagementApi get_cn_name GET /SSL/get_cn_name Request best SSL domain for service
CPanelAccountSSLManagementApi installed_host GET /SSL/installed_host Return SSL certificate's info for dedicated IP
CPanelAccountSSLManagementApi installed_hosts GET /SSL/installed_hosts Return domains with SSL certificate information
CPanelAccountSSLManagementApi list_certs GET /SSL/list_certs Return all SSL certificates
CPanelAccountSSLManagementApi list_csrs GET /SSL/list_csrs Return all certificate signing requests
CPanelAccountSSLManagementApi list_keys GET /SSL/list_keys Return all private keys
CPanelAccountSSLManagementApi list_ssl_items GET /SSL/list_ssl_items Return SSL-related items
CPanelAccountSSLManagementApi rebuildssldb GET /SSL/rebuildssldb Start SSL database rebuild
CPanelAccountSSLManagementApi s_sl_set_default_key_type GET /SSL/set_default_key_type Update SSL TLS key type
CPanelAccountSSLManagementApi toggle_ssl_redirect_for_domains GET /SSL/toggle_ssl_redirect_for_domains Enable or disable secure redirects
CPanelAddonsCPAddonsApi get_available_addons GET /cPAddons/get_available_addons Return available cPAddons
CPanelAddonsCPAddonsApi get_instance_settings GET /cPAddons/get_instance_settings Return deployed cPAddons instance's settings
CPanelAddonsCPAddonsApi list_addon_instances GET /cPAddons/list_addon_instances Return deployed cPAddons instances
CPanelFeaturesApi get_feature_metadata GET /Features/get_feature_metadata Return cPanel account's features' metadata
CPanelFeaturesApi has_feature GET /Features/has_feature Validate cPanel account's feature access
CPanelFeaturesApi list_features GET /Features/list_features Return cPanel account's features
CPanelServerInformationApi get_information GET /ServerInformation/get_information Return service and device status
CPanelServerInformationApi variables_get_server_information GET /Variables/get_server_information Return server's configuration settings

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Author

[email protected]