# cPanel UAPI UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings. Version: 11.134.0.5 License: cPanel License ## Servers A server running cPanel. ``` https://{host}:{port}/execute ``` Variables: - `host`: The hostname of a server running cPanel Default: "cpanel-server.tld" - `port`: The cPanel port. Default: "2083" ## Security ### BasicAuth Type: http Scheme: basic ## Download OpenAPI description [cPanel UAPI](https://api.docs.cpanel.net/_spec/specifications/cpanel.openapi.yaml) ## Tokens The Tokens module for UAPI. ### Create cPanel API token - [GET /Tokens/create_full_access](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/create_full_access.md): This function creates a new API token with full access to all of a cPanel account's features. The token grants access to the features that the account has access to. For example, if you disable the feature, the token can't access it. ### Return cPanel API tokens - [GET /Tokens/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/tokens-list.md): This function returns a list of a cPanel account's API tokens. ### Update cPanel API token's name - [GET /Tokens/rename](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/rename.md): This function renames a cPanel account's existing API token. ### Remove cPanel API token - [GET /Tokens/revoke](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/revoke.md): This function removes an API token from a cPanel account. ## API Token Management API Development Tools / API Token Management ### Create cPanel API token - [GET /Tokens/create_full_access](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/create_full_access.md): This function creates a new API token with full access to all of a cPanel account's features. The token grants access to the features that the account has access to. For example, if you disable the feature, the token can't access it. ### Return cPanel API tokens - [GET /Tokens/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/tokens-list.md): This function returns a list of a cPanel account's API tokens. ### Update cPanel API token's name - [GET /Tokens/rename](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/rename.md): This function renames a cPanel account's existing API token. ### Remove cPanel API token - [GET /Tokens/revoke](https://api.docs.cpanel.net/specifications/cpanel.openapi/api-token-management/revoke.md): This function removes an API token from a cPanel account. ## Batch The Batch module for UAPI. ### Run multiple UAPI functions in order - [GET /Batch/strict](https://api.docs.cpanel.net/specifications/cpanel.openapi/batch/strict.md): This function combines calls for multiple UAPI functions and performs them in order. * If a function call in the list fails, the function does not run further function calls in the list. * Due to the potential length of calls of this function, we recommend that you use the HTTP POST method for extremely long batch commands. ## UserTasks The UserTasks module for UAPI. ### Remove item from task queue - [GET /UserTasks/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/sse-task-management/usertasks::delete.md): This function deletes a process from the user task queue. Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server. Git Version Control* interface () uses the user task queue to clone repositories (via the function). * For more information, read our Task Queue Monitor documentation. ### Return task queue information - [GET /UserTasks/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/sse-task-management/retrieve.md): This function retrieves a cPanel account's user task queue information. Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server. Git Version Control* interface () uses the user task queue to clone repositories (via the function). * For more information, read our Task Queue Monitor documentation. ## SSE Task Management API Development Tools / SSE Task Management ### Remove item from task queue - [GET /UserTasks/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/sse-task-management/usertasks::delete.md): This function deletes a process from the user task queue. Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server. Git Version Control* interface () uses the user task queue to clone repositories (via the function). * For more information, read our Task Queue Monitor documentation. ### Return task queue information - [GET /UserTasks/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/sse-task-management/retrieve.md): This function retrieves a cPanel account's user task queue information. Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server. Git Version Control* interface () uses the user task queue to clone repositories (via the function). * For more information, read our Task Queue Monitor documentation. ## Integration The Integration module for UAPI. ### Return integrated application URL - [GET /Integration/fetch_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/url-parsing/fetch_url.md): This function returns the URL for an integrated application. ## URL Parsing API Development Tools / URL Parsing ### Return integrated application URL - [GET /Integration/fetch_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/url-parsing/fetch_url.md): This function returns the URL for an integrated application. ### Return session relative URI - [GET /Parser/firstfile_relative_uri](https://api.docs.cpanel.net/specifications/cpanel.openapi/url-parsing/firstfile_relative_uri.md): This function reports the first file's URI, relative to the cPanel base directory. ## Parser The Parser module for UAPI. ### Return session relative URI - [GET /Parser/firstfile_relative_uri](https://api.docs.cpanel.net/specifications/cpanel.openapi/url-parsing/firstfile_relative_uri.md): This function reports the first file's URI, relative to the cPanel base directory. ## ExternalAuthentication The ExternalAuthentication module for UAPI. ### Add external authentication link - [GET /ExternalAuthentication/add_authn_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/add_authn_link.md): This function adds an External Authentication authorization link to an account. ### Return server's external authentication providers - [GET /ExternalAuthentication/configured_modules](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/configured_modules.md): This function lists the display information for your server's available and configured external authentication identity provider modules. ### Return external authentication links - [GET /ExternalAuthentication/get_authn_links](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/get_authn_links.md): This function lists the external authentication links to the current cPanel account. ### Return external authentication user status - [GET /ExternalAuthentication/has_external_auth_modules_configured](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/has_external_auth_modules_configured.md): This function determines whether the user enabled external authentication modules. ### Remove external authentication link - [GET /ExternalAuthentication/remove_authn_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/remove_authn_link.md): This function removes a link to an account at an external authentication identity provider. ## External Authentication Authentication / External Authentication ### Add external authentication link - [GET /ExternalAuthentication/add_authn_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/add_authn_link.md): This function adds an External Authentication authorization link to an account. ### Return server's external authentication providers - [GET /ExternalAuthentication/configured_modules](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/configured_modules.md): This function lists the display information for your server's available and configured external authentication identity provider modules. ### Return external authentication links - [GET /ExternalAuthentication/get_authn_links](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/get_authn_links.md): This function lists the external authentication links to the current cPanel account. ### Return external authentication user status - [GET /ExternalAuthentication/has_external_auth_modules_configured](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/has_external_auth_modules_configured.md): This function determines whether the user enabled external authentication modules. ### Remove external authentication link - [GET /ExternalAuthentication/remove_authn_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/external-authentication/remove_authn_link.md): This function removes a link to an account at an external authentication identity provider. ## TwoFactorAuth The TwoFactorAuth module for UAPI. ### Create 2FA authentication code - [GET /TwoFactorAuth/generate_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/generate_user_configuration.md): This function generates an authentication code to enable configuration of two-factor authentication. ### Return team user 2FA config - [GET /TwoFactorAuth/get_team_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/get_team_user_configuration.md): This function retrieves a team user's configuration settings for two-factor authentication. ### Return cPanel account 2FA config - [GET /TwoFactorAuth/get_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/get_user_configuration.md): This function retrieves the cPanel account user's configuration settings for two-factor authentication. ### Remove 2FA config - [GET /TwoFactorAuth/remove_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/remove_user_configuration.md): This function removes the user from the two-factor authentication file. ### Save 2FA config - [GET /TwoFactorAuth/set_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/set_user_configuration.md): This function configures the two-factor authentication settings for an account. ## Two-Factor Settings Authentication / Two-Factor Settings ### Create 2FA authentication code - [GET /TwoFactorAuth/generate_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/generate_user_configuration.md): This function generates an authentication code to enable configuration of two-factor authentication. ### Return team user 2FA config - [GET /TwoFactorAuth/get_team_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/get_team_user_configuration.md): This function retrieves a team user's configuration settings for two-factor authentication. ### Return cPanel account 2FA config - [GET /TwoFactorAuth/get_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/get_user_configuration.md): This function retrieves the cPanel account user's configuration settings for two-factor authentication. ### Remove 2FA config - [GET /TwoFactorAuth/remove_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/remove_user_configuration.md): This function removes the user from the two-factor authentication file. ### Save 2FA config - [GET /TwoFactorAuth/set_user_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/two-factor-settings/set_user_configuration.md): This function configures the two-factor authentication settings for an account. ## BlockIP The BlockIP module for UAPI. ### Add IP address to cPanel account's block list - [GET /BlockIP/add_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/block-ip/blockip-add-ip.md): This function blocks IP addresses from accessing the domains on a cPanel account. When you disable the Web Server role, the system disables this function. ### Remove IP address from cPanel account's block list - [GET /BlockIP/remove_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/block-ip/blockip-remove-ip.md): This function unblocks IP addresses from accessing domains on a cPanel account. When you disable the Web Server role, the system disables this function. ## Block IP Block Ip Addresses / Block IP ### Add IP address to cPanel account's block list - [GET /BlockIP/add_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/block-ip/blockip-add-ip.md): This function blocks IP addresses from accessing the domains on a cPanel account. When you disable the Web Server role, the system disables this function. ### Remove IP address from cPanel account's block list - [GET /BlockIP/remove_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/block-ip/blockip-remove-ip.md): This function unblocks IP addresses from accessing domains on a cPanel account. When you disable the Web Server role, the system disables this function. ## Market The Market module for UAPI. ### Create shopping cart - [GET /Market/create_shopping_cart](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/create_shopping_cart.md): This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s function. ### Return provider's available products - [GET /Market/get_all_products](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/market-get_all_products.md): This function lists all products available through all enabled cPanel Market providers. ### Return provider's login URL - [GET /Market/get_login_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/get_login_url.md): This function retrieves the login URL for the cPanel Market provider. ### Return enabled providers - [GET /Market/get_providers_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/market-get_providers_list.md): This function lists the names of enabled cPanel Market providers. ### Update status of items in pending queue - [GET /Market/set_status_of_pending_queue_items](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/set_status_of_pending_queue_items.md): This function sets the status of an item or items in the cPanel Market pending queue. ### Update URL after checkout - [GET /Market/set_url_after_checkout](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/set_url_after_checkout.md): This function updates the URL to which a provider sends a user after they check out. ### Validate login token - [GET /Market/validate_login_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/validate_login_token.md): This function validates a login token to a cPanel Market provider and returns an access token. ### Delete an order - [GET /Market/cancel_pending_ssl_certificate](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/cancel_pending_ssl_certificate.md): This function cancels an order and removes the polling for a pending certificate. ### Return provider's SSL certificate request status - [GET /Market/get_certificate_status_details](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_certificate_status_details.md): This function returns the status of an SSL certificate request. The returns include actionable URLs for users to expedite the validation process, if applicable. Because this function returns data from a dynamic source, the returns in each object can vary. ### Return provider's pending SSL certificates - [GET /Market/get_pending_ssl_certificates](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_pending_ssl_certificates.md): This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls. ### Return provider's DCV filename requirements - [GET /Market/get_provider_specific_dcv_constraints](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/market-get_provider_specific_dcv_constraints.md): This function returns the provider's filename requirements for Domain Control Validation (DCV) checks. ### Return provider's available SSL certificates - [GET /Market/get_ssl_certificate_if_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_ssl_certificate_if_available.md): This function retrieves SSL certificates when they are available from the cPanel Market provider. ### Start processing pending queue's SSL certificates - [GET /Market/process_ssl_pending_queue](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/process_ssl_pending_queue.md): This function manually processes the cPanel Market's SSL certificate request pending queue. ### Request SSL certificate order - [GET /Market/request_ssl_certificates](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/request_ssl_certificates.md): This function submits a request for a certificate order to the cPanel Market provider. ## Market Integration Commerce Integration / Market Integration ### Create shopping cart - [GET /Market/create_shopping_cart](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/create_shopping_cart.md): This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s function. ### Return provider's available products - [GET /Market/get_all_products](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/market-get_all_products.md): This function lists all products available through all enabled cPanel Market providers. ### Return provider's login URL - [GET /Market/get_login_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/get_login_url.md): This function retrieves the login URL for the cPanel Market provider. ### Return enabled providers - [GET /Market/get_providers_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/market-get_providers_list.md): This function lists the names of enabled cPanel Market providers. ### Update status of items in pending queue - [GET /Market/set_status_of_pending_queue_items](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/set_status_of_pending_queue_items.md): This function sets the status of an item or items in the cPanel Market pending queue. ### Update URL after checkout - [GET /Market/set_url_after_checkout](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/set_url_after_checkout.md): This function updates the URL to which a provider sends a user after they check out. ### Validate login token - [GET /Market/validate_login_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/market-integration/validate_login_token.md): This function validates a login token to a cPanel Market provider and returns an access token. ## SSL Certificates Commerce Integration / SSL Certificates ### Delete an order - [GET /Market/cancel_pending_ssl_certificate](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/cancel_pending_ssl_certificate.md): This function cancels an order and removes the polling for a pending certificate. ### Return provider's SSL certificate request status - [GET /Market/get_certificate_status_details](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_certificate_status_details.md): This function returns the status of an SSL certificate request. The returns include actionable URLs for users to expedite the validation process, if applicable. Because this function returns data from a dynamic source, the returns in each object can vary. ### Return provider's pending SSL certificates - [GET /Market/get_pending_ssl_certificates](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_pending_ssl_certificates.md): This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls. ### Return provider's DCV filename requirements - [GET /Market/get_provider_specific_dcv_constraints](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/market-get_provider_specific_dcv_constraints.md): This function returns the provider's filename requirements for Domain Control Validation (DCV) checks. ### Return provider's available SSL certificates - [GET /Market/get_ssl_certificate_if_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/get_ssl_certificate_if_available.md): This function retrieves SSL certificates when they are available from the cPanel Market provider. ### Start processing pending queue's SSL certificates - [GET /Market/process_ssl_pending_queue](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/process_ssl_pending_queue.md): This function manually processes the cPanel Market's SSL certificate request pending queue. ### Request SSL certificate order - [GET /Market/request_ssl_certificates](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificates/request_ssl_certificates.md): This function submits a request for a certificate order to the cPanel Market provider. ## ContactInformation The ContactInformation module for UAPI. ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Return Pushbullet access token - [GET /ContactInformation/get_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_pushbullet_access_token.md): This function retrieves the cPanel account's Pushbullet™ access token. ### Set contact email address(es) - [GET /ContactInformation/set_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_email_addresses.md): Use this function to set an account's contact email address(es). To unset all contact email addresses, call . ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ### Update Pushbullet access token - [GET /ContactInformation/set_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_pushbullet_access_token.md): This function updates the cPanel account's Pushbullet™ access token. ### Unset contact email addresses - [GET /ContactInformation/unset_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-unset_email_addresses.md): Use this function to unset all contact email address for an account. To set contact email address(es), call . ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Return Pushbullet access token - [GET /ContactInformation/get_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_pushbullet_access_token.md): This function retrieves the cPanel account's Pushbullet™ access token. ### Set contact email address(es) - [GET /ContactInformation/set_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_email_addresses.md): Use this function to set an account's contact email address(es). To unset all contact email addresses, call . ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ### Update Pushbullet access token - [GET /ContactInformation/set_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_pushbullet_access_token.md): This function updates the cPanel account's Pushbullet™ access token. ### Unset contact email addresses - [GET /ContactInformation/unset_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-unset_email_addresses.md): Use this function to unset all contact email address for an account. To set contact email address(es), call . ## Contact Information Contact Information ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Return Pushbullet access token - [GET /ContactInformation/get_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_pushbullet_access_token.md): This function retrieves the cPanel account's Pushbullet™ access token. ### Set contact email address(es) - [GET /ContactInformation/set_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_email_addresses.md): Use this function to set an account's contact email address(es). To unset all contact email addresses, call . ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ### Update Pushbullet access token - [GET /ContactInformation/set_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_pushbullet_access_token.md): This function updates the cPanel account's Pushbullet™ access token. ### Unset contact email addresses - [GET /ContactInformation/unset_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-unset_email_addresses.md): Use this function to unset all contact email address for an account. To set contact email address(es), call . ### Return whether contact option is enabled - [GET /Contactus/is_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/is_enabled.md): This function checks whether the cPanel account can contact their hosting provider from the cPanel interface. ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Return Pushbullet access token - [GET /ContactInformation/get_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_pushbullet_access_token.md): This function retrieves the cPanel account's Pushbullet™ access token. ### Set contact email address(es) - [GET /ContactInformation/set_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_email_addresses.md): Use this function to set an account's contact email address(es). To unset all contact email addresses, call . ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ### Update Pushbullet access token - [GET /ContactInformation/set_pushbullet_access_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_pushbullet_access_token.md): This function updates the cPanel account's Pushbullet™ access token. ### Unset contact email addresses - [GET /ContactInformation/unset_email_addresses](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-unset_email_addresses.md): Use this function to unset all contact email address for an account. To set contact email address(es), call . ### Return whether contact option is enabled - [GET /Contactus/is_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/is_enabled.md): This function checks whether the cPanel account can contact their hosting provider from the cPanel interface. ## notifications ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ### Return the account's notification preferences. - [GET /ContactInformation/get_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-get_notification_preferences.md): Use this function to get a cPanel or Webmail account's notification preferences. ### Set the account's notification preferences. - [POST /ContactInformation/set_notification_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/contactinformation-set_notification_preferences.md): Use this function to set the logged in cPanel or Webmail account's notification preferences. To set a cPanel account's notification email address, call . To return the list of account notification preferences you can set with , call . ## Contactus The Contactus module for UAPI. ### Return whether contact option is enabled - [GET /Contactus/is_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/is_enabled.md): This function checks whether the cPanel account can contact their hosting provider from the cPanel interface. ### Return whether contact option is enabled - [GET /Contactus/is_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/contact-information/is_enabled.md): This function checks whether the cPanel account can contact their hosting provider from the cPanel interface. ## Account Enhancements The Account Enhancement module for UAPI. ### Validate Account Enhancement assignment - [GET /AccountEnhancements/has_enhancement](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-enhancements/accountenhancements-has-enhancement.md): This function returns whether a cPanel account has a specific Account Enhancement. ### Return all cPanel account's Account Enhancements - [GET /AccountEnhancements/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-enhancements/accountenhancements-list.md): This function lists a cPanel account's Account Enhancements. ## Resellers The Resellers module for UAPI. ### Return reseller's cPanel accounts - [GET /Resellers/list_accounts](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-information/list_accounts.md): This function lists all of a reseller's cPanel accounts. ## Account Information cPanel Account / Account Information ### Return reseller's cPanel accounts - [GET /Resellers/list_accounts](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-information/list_accounts.md): This function lists all of a reseller's cPanel accounts. ### Return cPanel account's configuration settings - [GET /Variables/get_user_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-information/variables-get_user_information.md): This function retrieves the user's account configuration settings. ## Variables The Variables module for UAPI. ### Return cPanel account's configuration settings - [GET /Variables/get_user_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-information/variables-get_user_information.md): This function retrieves the user's account configuration settings. ### Return web server's hostname - [GET /Variables/get_session_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/login-information/get_session_information.md): This function retrieves a web server's hostname. ### Return server's configuration settings - [GET /Variables/get_server_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-server-information/variables-get_server_information.md): This function retrieves the configuration settings for the cPanel & WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account. ## Leika The Leika module for cPanel UAPI. ### Return Leika configuration - [GET /Leika/leika_get_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/leika_get_config.md): This function returns Leika configuration data. Leika is an internal module that cPanel & WHM uses to track access to features. If you do not provide an parameter, this returns the configuration. ## Account Management cPanel Account / Account Management ### Return Leika configuration - [GET /Leika/leika_get_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/leika_get_config.md): This function returns Leika configuration data. Leika is an internal module that cPanel & WHM uses to track access to features. If you do not provide an parameter, this returns the configuration. ### Update cPanel account password - [GET /UserManager/change_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/change_password.md): This function updates the cPanel account's password. ### Update cPanel account password - [GET /Users/change_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/users_change_password.md): This function updates the cPanel account's password. ## UserManager The UserManager module for UAPI. ### Update cPanel account password - [GET /UserManager/change_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/change_password.md): This function updates the cPanel account's password. ### Return Subaccounts and service accounts conflicts - [GET /UserManager/check_account_conflicts](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/check_account_conflicts.md): This function lists the other Subaccounts or services accounts that conflict with the specified username. If the function returns more than one account, it will return some values multiple times within the return arrays. ### Create Subaccount - [GET /UserManager/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager::create_user.md): This function creates a Subaccount. ### Delete Subaccount - [GET /UserManager/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager::delete_user.md): This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain. * If one service account uses the same username and domain, the function returns the service account's information. * If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount. * A hypothetical Subaccount consists of two or more service accounts that use the same username and domain. * This function returns only metadata if the specified username and domain do match any service accounts or hypothetical Subaccounts. ### Remove service account link request - [GET /UserManager/dismiss_merge](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/dismiss_merge.md): This function removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the option in cPanel's  interface (_cPanel >> Home >> Preferences >> User Manager_). You use at least one of the following parameters: * * * ### Update Subaccount settings - [GET /UserManager/edit_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/edit_user.md): This function edits a Subaccount. ### Return cPanel account's Subaccounts - [GET /UserManager/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager-list_users.md): This function lists the cPanel account's Subaccounts. ### Return service account's information - [GET /UserManager/lookup_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/lookup_service_account.md): This function lists a service account's information. ### Return Subaccount's information - [GET /UserManager/lookup_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/lookup_user.md): This function lists a single Subaccount's information. ### Register service account to Subaccount - [GET /UserManager/merge_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/merge_service_account.md): This function links service accounts to subaccounts and creates a subaccount if one does not exist. You can only link email, FTP, or Web Disk accounts. You must use at least of the following parameters: * services.email.merge * services.ftp.merge * services.webdisk.merge To link multiple service accounts, the service accounts share the same username and domain. ### Unregister service account from Subaccount - [GET /UserManager/unlink_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/unlink_service_account.md): This function unlinks a service account from a subaccount. ## Users The Users module for UAPI. ### Update cPanel account password - [GET /Users/change_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/account-management/users_change_password.md): This function updates the cPanel account's password. ## Features The Features module for UAPI. ### Return cPanel account's features' metadata - [GET /Features/get_feature_metadata](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/get_feature_metadata.md): This function lists the details of a cPanel account's available feature lists. ### Validate cPanel account's feature access - [GET /Features/has_feature](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/has_feature.md): This function checks whether a cPanel account has access to a feature. ### Return whether queried features are enabled - [GET /Features/has_features_like](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/has_features_like.md): This function allows you to search for cPanel account features and determine whether those features are enabled. ### Return cPanel account's features - [GET /Features/list_features](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/list_features.md): This function lists a cPanel account's features. ### Return queried cPanel account features - [GET /Features/list_features_like](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/list_features_like.md): This function allows you to search for enabled cPanel account features and lists those features in the returned payload. ## cPanel Features cPanel Account / cPanel Features ### Return cPanel account's features' metadata - [GET /Features/get_feature_metadata](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/get_feature_metadata.md): This function lists the details of a cPanel account's available feature lists. ### Validate cPanel account's feature access - [GET /Features/has_feature](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/has_feature.md): This function checks whether a cPanel account has access to a feature. ### Return whether queried features are enabled - [GET /Features/has_features_like](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/has_features_like.md): This function allows you to search for cPanel account features and determine whether those features are enabled. ### Return cPanel account's features - [GET /Features/list_features](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/list_features.md): This function lists a cPanel account's features. ### Return queried cPanel account features - [GET /Features/list_features_like](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-features/list_features_like.md): This function allows you to search for enabled cPanel account features and lists those features in the returned payload. ## Quota The Quota module for UAPI. ### Return local disk quota information - [GET /Quota/get_local_quota_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/disk-quotas/get_local_quota_info.md): This function retrieves the cPanel account's quota for the server where you run the function. For example, a distributed cPanel account could approach its quota. The servers will balance that cPanel user's quota between the parent and the child node. This function runs on the local server. To retrieve the cPanel account's total quota, use the UAPI function instead. ### Return disk quota information - [GET /Quota/get_quota_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/disk-quotas/get_quota_info.md): This function retrieves the cPanel account's quota. ## Disk Quotas cPanel Account / Disk Quotas ### Return local disk quota information - [GET /Quota/get_local_quota_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/disk-quotas/get_local_quota_info.md): This function retrieves the cPanel account's quota for the server where you run the function. For example, a distributed cPanel account could approach its quota. The servers will balance that cPanel user's quota between the parent and the child node. This function runs on the local server. To retrieve the cPanel account's total quota, use the UAPI function instead. ### Return disk quota information - [GET /Quota/get_quota_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/disk-quotas/get_quota_info.md): This function retrieves the cPanel account's quota. ## Personalization The Personalization module for UAPI. ### Retrieve NVData data from file - [POST /Personalization/get](https://api.docs.cpanel.net/specifications/cpanel.openapi/personalization/personalization::get.md): This function retrieves the data from an NVData file on disk. cPanel NVData is a per-account configuration storage mechanism that you can use to maintain persistent cPanel & WHM settings across multiple sessions. This includes custom settings for your own themes and plugins. NVData keys and values are limited to 128 and 2048 bytes, respectively. ### Save NVData data to file - [POST /Personalization/set](https://api.docs.cpanel.net/specifications/cpanel.openapi/personalization/personalization-set.md): This function saves its data to an NVData file on disk. cPanel NVData is a per-account configuration storage mechanism that you can use to maintain persistent cPanel & WHM settings across multiple sessions. This includes custom settings for your own themes and plugins. NVData keys and values are limited to 128 and 2048 bytes, respectively. ## ResourceUsage The ResourceUsage module for UAPI. ### Return resource usage and custom statistics - [GET /ResourceUsage/get_usages](https://api.docs.cpanel.net/specifications/cpanel.openapi/resource-usage-and-statistics/get_usages.md): This function retrieves resource usage and custom statistics for a cPanel user account. ## Resource Usage and Statistics cPanel Account / Resource Usage and Statistics ### Return resource usage and custom statistics - [GET /ResourceUsage/get_usages](https://api.docs.cpanel.net/specifications/cpanel.openapi/resource-usage-and-statistics/get_usages.md): This function retrieves resource usage and custom statistics for a cPanel user account. ### Return cPanel account statistics - [GET /StatsBar/get_stats](https://api.docs.cpanel.net/specifications/cpanel.openapi/resource-usage-and-statistics/get_stats.md): This function retrieves a cPanel account's statistics. ## StatsBar The StatsBar module for UAPI. ### Return cPanel account statistics - [GET /StatsBar/get_stats](https://api.docs.cpanel.net/specifications/cpanel.openapi/resource-usage-and-statistics/get_stats.md): This function retrieves a cPanel account's statistics. ## Subaccount Management cPanel Account / Subaccount Management ### Return Subaccounts and service accounts conflicts - [GET /UserManager/check_account_conflicts](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/check_account_conflicts.md): This function lists the other Subaccounts or services accounts that conflict with the specified username. If the function returns more than one account, it will return some values multiple times within the return arrays. ### Create Subaccount - [GET /UserManager/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager::create_user.md): This function creates a Subaccount. ### Delete Subaccount - [GET /UserManager/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager::delete_user.md): This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain. * If one service account uses the same username and domain, the function returns the service account's information. * If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount. * A hypothetical Subaccount consists of two or more service accounts that use the same username and domain. * This function returns only metadata if the specified username and domain do match any service accounts or hypothetical Subaccounts. ### Remove service account link request - [GET /UserManager/dismiss_merge](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/dismiss_merge.md): This function removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the option in cPanel's  interface (_cPanel >> Home >> Preferences >> User Manager_). You use at least one of the following parameters: * * * ### Update Subaccount settings - [GET /UserManager/edit_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/edit_user.md): This function edits a Subaccount. ### Return cPanel account's Subaccounts - [GET /UserManager/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/usermanager-list_users.md): This function lists the cPanel account's Subaccounts. ### Return service account's information - [GET /UserManager/lookup_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/lookup_service_account.md): This function lists a service account's information. ### Return Subaccount's information - [GET /UserManager/lookup_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/lookup_user.md): This function lists a single Subaccount's information. ### Register service account to Subaccount - [GET /UserManager/merge_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/merge_service_account.md): This function links service accounts to subaccounts and creates a subaccount if one does not exist. You can only link email, FTP, or Web Disk accounts. You must use at least of the following parameters: * services.email.merge * services.ftp.merge * services.webdisk.merge To link multiple service accounts, the service accounts share the same username and domain. ### Unregister service account from Subaccount - [GET /UserManager/unlink_service_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/subaccount-management/unlink_service_account.md): This function unlinks a service account from a subaccount. ## Team Roles The Team Roles module for UAPI. ### List all role feature descriptions - [GET /TeamRoles/list_feature_descriptions](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-roles/list_feature_descriptions.md): This function gives a list of all team roles and their included features. ## Team Users The Team User module for UAPI. ### Add roles to a team user - [GET /Team/add_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/add_roles.md): This function adds roles to a team user. This action may result in team users gaining access to team owner level privileges. ### Add a team user - [GET /Team/add_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/add_team_user.md): This function creates and adds a new team user. This action may result in team users gaining access to team owner level privileges. ### Stop a team user from expiring - [GET /Team/cancel_expire](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/cancel_expire.md): This function stops a team user from expiring. ### Edit a team user - [GET /Team/edit_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/edit_team_user.md): This function modifies a team user. ### Get number of team users with roles - [GET /Team/get_team_users_with_roles_count](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/get_team_users_with_roles_count.md): This function returns the current and maximum number of team users with roles. ### List Team Users - [GET /Team/list_team](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/list_team.md): This function lists the team users connected to a cPanel account. This list is given in an array by default, but can be given in a hash. ### Sends a password reset request link to team user. - [GET /Team/password_reset_request](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/password_reset_request.md): This function enables a team user to reset the password by sending a password reset request link. ### Reinstate a team user - [GET /Team/reinstate_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/reinstate_team_user.md): This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared. ### Remove roles from a team user - [GET /Team/remove_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/remove_roles.md): This function removes roles from a team user. ### Remove a team user - [GET /Team/remove_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/remove_team_user.md): This function removes a team user. ### Set a contact email address for a team user - [GET /Team/set_contact_email](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_contact_email.md): This function sets or changes primary and secondary email addresses. ### Set a team user to expire - [GET /Team/set_expire](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_expire.md): This function expires a team user after a specified amount of time. If the team user already has an expire date set, it's replaced with a new date and reason. ### Set locale for a team user - [GET /Team/set_locale](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/team::set_locale.md): This function sets locale for a team user. ### Set notes for a team user - [GET /Team/set_notes](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_notes.md): This function replaces the current notes field with new text. ### Set password for a team user - [GET /Team/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_team_user_password.md): This function replaces the current password with a new one. ### Set roles for a team user - [GET /Team/set_roles](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/set_roles.md): This function sets roles for a team user. This action may result in team users gaining access to team owner level privileges. ### Suspend a team user - [GET /Team/suspend_team_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/team-users/suspend_team_user.md): This function immediately suspends a team user. ## Backup The Backup module for UAPI. ### Back up cPanel account via FTP - [GET /Backup/fullbackup_to_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/backup/fullbackup_to_ftp.md): This function creates a full backup to the remote server via File Transfer Protocol (FTP). The system creates a file in the  filename format. ### Back up cPanel account to home directory - [GET /Backup/fullbackup_to_homedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/backup/fullbackup_to_homedir.md): This function creates a full backup to the user's home directory. The system creates a file in the  filename format. ### Back up cPanel account via SCP with SSH key - [GET /Backup/fullbackup_to_scp_with_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/backup/fullbackup_to_scp_with_key.md): This function creates a full backup to a remote server with a private SSH key via the secure copy protocol (scp) command. The system creates a file in the  filename format. ### Back up cPanel account via SCP with password - [GET /Backup/fullbackup_to_scp_with_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/backup/fullbackup_to_scp_with_password.md): This function creates a full backup to a remote server via the secure copy protocol () command with a password. The system creates a file in the  filename format. ### Return backup files - [GET /Backup/list_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/backup/list_backups.md): This function lists the account's backup files. ## File Restoration cPanel Account Backups / File Restoration ### Restore databases - [POST /Backup/restore_databases](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/restore_databases.md): This function restores a database's backup files. When the MySQL Client role is disabled, the system also this function. You pass either the parameter. ### Restore email filters - [POST /Backup/restore_email_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/restore_email_filters.md): This function restores an account's email filters. When the Receive Mail role is disabled, the system also this function. You use the parameter when you call this function in one of the following formats: * As part of a request body to upload and restore a backup file to the server. * As a query parameter to restore an existing file on the server. ### Restore email forwarders - [POST /Backup/restore_email_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/restore_email_forwarders.md): This function restores an account's email forwarders. When the Receive Mail role is disabled, the system also this function. You use the parameter when you call this function in one of the following formats: * As part of a request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's POST Method documentation. * As a query parameter to restore an existing file on the server. ### Restore files - [POST /Backup/restore_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/restore_files.md): This function restores an account's files. When the File Storage role is disabled, the system also this function. You use the parameter when you call this function in one of the following formats: * As part of a request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's POST Method documentation. * As a query parameter to restore an existing file on the server. ### Return backups in home directory - [GET /Restore/directory_listing](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/directory_listing.md): This function lists all of the backup files and directories in the user's home directory. When you disable the File Storage role, the system this function. ### Return cPanel accounts with backup metadata - [GET /Restore/get_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/get_users.md): This function lists a reseller's users that have existing backup metadata. When you disable the File Storage role, the system this function. ### Return backup storage locations - [GET /Restore/query_file_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/query_file_info.md): This function lists all of an item's backup locations. An item can be a file, a directory, or a symlink. When you disable the File Storage role, the system this function. ### Restore file or directory - [GET /Restore/restore_file](https://api.docs.cpanel.net/specifications/cpanel.openapi/file-restoration/restore_file.md): This function restores a file or directory from a backup to the file or directory's original location. When you disable the File Storage role, the system this function. ## Plugins The Plugins module for UAPI. ### Enable plugin promotions - [GET /Plugins/can_show_promotions](https://api.docs.cpanel.net/specifications/cpanel.openapi/plugins/plugins-can_show_promotions.md): This function determines if plugin promotions show in cPanel. ### Create third-party user - [GET /Plugins/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/plugins/plugins-create_user.md): This function implements third-party user creation. ## Branding The Branding module for UAPI. ### Return single app's info from dynamicui.conf - [GET /Branding/get_application_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_application_information.md): This function retrieves an application's information from the file. ### Return multiple apps' info from dynamicui.conf - [GET /Branding/get_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_applications.md): This function retrieves an application's information from a specific theme's file. ### Return current user's cPanel application details - [GET /Branding/get_available_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_available_applications.md): This function retrieves information about the groups and applications in the authenticated user's cPanel interface. ### Return app's info from sitemap.json - [GET /Branding/get_information_for_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_information_for_applications.md): This function retrieves an application's information from a specific theme's file. ## Application Information cPanel Theme Management / Application Information ### Return single app's info from dynamicui.conf - [GET /Branding/get_application_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_application_information.md): This function retrieves an application's information from the file. ### Return multiple apps' info from dynamicui.conf - [GET /Branding/get_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_applications.md): This function retrieves an application's information from a specific theme's file. ### Return current user's cPanel application details - [GET /Branding/get_available_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_available_applications.md): This function retrieves information about the groups and applications in the authenticated user's cPanel interface. ### Return app's info from sitemap.json - [GET /Branding/get_information_for_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-information/get_information_for_applications.md): This function retrieves an application's information from a specific theme's file. ## Chrome The Chrome module for UAPI. ### Return cPanel theme header and footer HTML - [GET /Chrome/get_dom](https://api.docs.cpanel.net/specifications/cpanel.openapi/brand-management/get_dom.md): This function returns header and footer HTML. You can use this HTML to create a page with the same visual appearance as your cPanel theme. ## Brand Management cPanel Theme Management / Brand Management ### Return cPanel theme header and footer HTML - [GET /Chrome/get_dom](https://api.docs.cpanel.net/specifications/cpanel.openapi/brand-management/get_dom.md): This function returns header and footer HTML. You can use this HTML to create a page with the same visual appearance as your cPanel theme. ## CacheBuster The CacheBuster module for UAPI. ### Return web browser cached file override ID - [GET /CacheBuster/read](https://api.docs.cpanel.net/specifications/cpanel.openapi/browser-cache-management/cachebuster-read.md): This function returns the current id. The system uses this ID to force the browser to fetch a new resource when that resource already exists in the web browser cache. This is useful when an application has updated the resource on the server. You should append this ID to the end of the url in the query-string. For example, if you are accessing a url like: To force the browser to fetch the updated version, you would append the following: The application that updates the resource at this url on the server call the function when it updates the resource to signify that update. ### Create web browser cached file override ID - [GET /CacheBuster/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/browser-cache-management/update.md): This function generates a random integer (the CacheBuster ID). Use this ID to work with and around a browser's caching mechanism. ## Browser Cache Management cPanel Theme Management / Browser Cache Management ### Return web browser cached file override ID - [GET /CacheBuster/read](https://api.docs.cpanel.net/specifications/cpanel.openapi/browser-cache-management/cachebuster-read.md): This function returns the current id. The system uses this ID to force the browser to fetch a new resource when that resource already exists in the web browser cache. This is useful when an application has updated the resource on the server. You should append this ID to the end of the url in the query-string. For example, if you are accessing a url like: To force the browser to fetch the updated version, you would append the following: The application that updates the resource at this url on the server call the function when it updates the resource to signify that update. ### Create web browser cached file override ID - [GET /CacheBuster/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/browser-cache-management/update.md): This function generates a random integer (the CacheBuster ID). Use this ID to work with and around a browser's caching mechanism. ## Locale The Locale module for UAPI. ### Return current locale settings - [GET /Locale/get_attributes](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/get_attributes.md): This function retrieves information about the user's current locale setting. ### Return available locales - [GET /Locale/list_locales](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/list_locales.md): This function lists an account's available interface languages. ### Update cPanel account locale - [GET /Locale/set_locale](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/set_locale.md): This function sets the account's locale. ## Language cPanel Theme Management / Language ### Return current locale settings - [GET /Locale/get_attributes](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/get_attributes.md): This function retrieves information about the user's current locale setting. ### Return available locales - [GET /Locale/list_locales](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/list_locales.md): This function lists an account's available interface languages. ### Update cPanel account locale - [GET /Locale/set_locale](https://api.docs.cpanel.net/specifications/cpanel.openapi/language/set_locale.md): This function sets the account's locale. ## Themes The Themes module for UAPI. ### Return available themes - [GET /Themes/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/themes::list.md): This function lists available themes. The script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. ### Update current theme - [GET /Themes/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/themes::update.md): This function applies a new theme to the cPanel interface. The script allows you to modify the theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. ### Return current theme (deprecated) - [GET /Themes/get_theme_base](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/get_theme_base.md): This function is deprecated and does not return useful output. ## Theme Settings cPanel Theme Management / Theme Settings ### Return available themes - [GET /Themes/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/themes::list.md): This function lists available themes. The script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. ### Update current theme - [GET /Themes/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/themes::update.md): This function applies a new theme to the cPanel interface. The script allows you to modify the theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. ### Return current theme (deprecated) - [GET /Themes/get_theme_base](https://api.docs.cpanel.net/specifications/cpanel.openapi/theme-settings/get_theme_base.md): This function is deprecated and does not return useful output. ## DirectoryIndexes The DirectoryIndexes module for UAPI. ### Return directory indexing settings - [GET /DirectoryIndexes/get_indexing](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/get_indexing.md): This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories. ### Return subdirectories directory indexing settings - [GET /DirectoryIndexes/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/directoryindexes-list_directories.md): This function returns the directory indexing settings of the subdirectories in a directory. ### Update directory indexing settings - [GET /DirectoryIndexes/set_indexing](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/set_indexing.md): This function configures the directory indexing settings for a directory on the cPanel account. ## Directory Indexes Directory Management / Directory Indexes ### Return directory indexing settings - [GET /DirectoryIndexes/get_indexing](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/get_indexing.md): This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories. ### Return subdirectories directory indexing settings - [GET /DirectoryIndexes/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/directoryindexes-list_directories.md): This function returns the directory indexing settings of the subdirectories in a directory. ### Update directory indexing settings - [GET /DirectoryIndexes/set_indexing](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-indexes/set_indexing.md): This function configures the directory indexing settings for a directory on the cPanel account. ## DirectoryPrivacy The DirectoryPrivacy module for UAPI. ### Add authorized user for protected directory - [GET /DirectoryPrivacy/add_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/add_user.md): This function adds a user who can access a protected directory on the cPanel account. ### Enable or disable protected directory - [GET /DirectoryPrivacy/configure_directory_protection](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/configure_directory_protection.md): This function enables or disables password protection for a directory on the cPanel account. ### Delete authorized user for protected directory - [GET /DirectoryPrivacy/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/delete_user.md): This function deletes a user who can access a protected directory on the cPanel account. ### Return whether directory uses password protection - [GET /DirectoryPrivacy/is_directory_protected](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/is_directory_protected.md): This function confirms whether a directory uses password protection. ### Return privacy status of subdirectories - [GET /DirectoryPrivacy/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/directoryprivacy-list_directories.md): This function returns the privacy status of the subdirectories in a directory. ### Return authorized users for protected directory - [GET /DirectoryPrivacy/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/directoryprivacy::list_users.md): This function returns the users who can access a password-protected directory on the cPanel account. ## Directory Privacy Directory Management / Directory Privacy ### Add authorized user for protected directory - [GET /DirectoryPrivacy/add_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/add_user.md): This function adds a user who can access a protected directory on the cPanel account. ### Enable or disable protected directory - [GET /DirectoryPrivacy/configure_directory_protection](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/configure_directory_protection.md): This function enables or disables password protection for a directory on the cPanel account. ### Delete authorized user for protected directory - [GET /DirectoryPrivacy/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/delete_user.md): This function deletes a user who can access a protected directory on the cPanel account. ### Return whether directory uses password protection - [GET /DirectoryPrivacy/is_directory_protected](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/is_directory_protected.md): This function confirms whether a directory uses password protection. ### Return privacy status of subdirectories - [GET /DirectoryPrivacy/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/directoryprivacy-list_directories.md): This function returns the privacy status of the subdirectories in a directory. ### Return authorized users for protected directory - [GET /DirectoryPrivacy/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-privacy/directoryprivacy::list_users.md): This function returns the users who can access a password-protected directory on the cPanel account. ## DirectoryProtection The DirectoryProtection module for UAPI. ### Return Directory Protection settings - [GET /DirectoryProtection/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-protection/directoryprotection-list_directories.md): This function returns the leech protection settings of the subdirectories in a directory. ## Directory Protection Directory Management / Directory Protection ### Return Directory Protection settings - [GET /DirectoryProtection/list_directories](https://api.docs.cpanel.net/specifications/cpanel.openapi/directory-protection/directoryprotection-list_directories.md): This function returns the leech protection settings of the subdirectories in a directory. ## DNS The DNS module for UAPI. ### Return whether domains only resolve locally - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server. ### Return whether local DNS server is authoritative - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records. ### Return DNS record availability & resolver - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns::is_alias_available.md): This function returns whether and records are available and the value of the running PowerDNS (PDNS) setting, if any exists. For more information, read our documentation. ### Return DNS HTTPS record support information - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/is_https_available.md): This function fetches information regarding HTTPS records support. HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints. For more information, read our HTTPS record documentation. ### Return domain's DNS information - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-lookup.md): This function returns DNS zone information about a domain. ### Update a DNS zone - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit. You cannot use this function to edit temporary domains. ### Return a parsed DNS zone - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-parse_zone.md): This function parses a given DNS zone. Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output be able to handle cases where the decoded octets do not match any specific character encoding. ### Update IP addresses in zone files - [GET /DNS/swap_ip_in_zones](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-swap_ip_in_zones.md): This function replaces a domain's IPv4 address in the DNS zone file with the specified destination IPv4 address. ### Return whether domains only resolve locally - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server. ### Return whether local DNS server is authoritative - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records. ### Return DNS record availability & resolver - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns::is_alias_available.md): This function returns whether and records are available and the value of the running PowerDNS (PDNS) setting, if any exists. For more information, read our documentation. ### Return DNS HTTPS record support information - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/is_https_available.md): This function fetches information regarding HTTPS records support. HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints. For more information, read our HTTPS record documentation. ### Return domain's DNS information - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-lookup.md): This function returns DNS zone information about a domain. ### Update a DNS zone - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit. You cannot use this function to edit temporary domains. ### Return a parsed DNS zone - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-parse_zone.md): This function parses a given DNS zone. Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output be able to handle cases where the decoded octets do not match any specific character encoding. ## DNS Information DNS / DNS Information ### Return whether domains only resolve locally - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server. ### Return whether local DNS server is authoritative - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records. ### Return DNS record availability & resolver - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns::is_alias_available.md): This function returns whether and records are available and the value of the running PowerDNS (PDNS) setting, if any exists. For more information, read our documentation. ### Return DNS HTTPS record support information - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/is_https_available.md): This function fetches information regarding HTTPS records support. HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints. For more information, read our HTTPS record documentation. ### Return domain's DNS information - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-lookup.md): This function returns DNS zone information about a domain. ### Update a DNS zone - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit. You cannot use this function to edit temporary domains. ### Return a parsed DNS zone - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns/dns-parse_zone.md): This function parses a given DNS zone. Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output be able to handle cases where the decoded octets do not match any specific character encoding. ### Return whether domains only resolve locally - [GET /DNS/ensure_domains_reside_only_locally](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/ensure_domains_reside_only_locally.md): This function indicates whether the account's domains resolve exclusively to this server. ### Return whether local DNS server is authoritative - [GET /DNS/has_local_authority](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/has_local_authority.md): This function checks whether the local server is authoritative for the domain's DNS records. ### Return DNS record availability & resolver - [GET /DNS/is_alias_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns::is_alias_available.md): This function returns whether and records are available and the value of the running PowerDNS (PDNS) setting, if any exists. For more information, read our documentation. ### Return DNS HTTPS record support information - [GET /DNS/is_https_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/is_https_available.md): This function fetches information regarding HTTPS records support. HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints. For more information, read our HTTPS record documentation. ### Return domain's DNS information - [GET /DNS/lookup](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-lookup.md): This function returns DNS zone information about a domain. ### Update a DNS zone - [GET /DNS/mass_edit_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-mass_edit_zone.md): This function updates a DNS zone by allowing multiple records to be added, modified, or removed in a single call. It also ensures modified records occupy the same number of lines as before the edit. You cannot use this function to edit temporary domains. ### Return a parsed DNS zone - [GET /DNS/parse_zone](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-information/dns-parse_zone.md): This function parses a given DNS zone. Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output be able to handle cases where the decoded octets do not match any specific character encoding. ## DNSSEC The DNSSEC module for UAPI. ### Enable DNSSEC security key - [GET /DNSSEC/activate_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/activate_zone_key.md): This function activates a DNSSEC security key. When you disable the DNS role, the system this function. ### Create DNSSEC security key - [GET /DNSSEC/add_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/add_zone_key.md): This function generates a DNSSEC zone key for a domain. * After you enable DNSSEC on the domain, you add the DS records to your registrar. * You modify the DNSSEC security key. To make any changes, you disable (and delete) and re-create the DNSSEC security key. When you disable the DNS role, the system this function. ### Disable DNSSEC security key - [GET /DNSSEC/deactivate_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/deactivate_zone_key.md): This function deactivates a DNSSEC security key. When you disable the role, the system this function. ### Disable DNSSEC - [GET /DNSSEC/disable_dnssec](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/disable_dnssec.md): This function disables DNSSEC on the domain. * This action is . If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup. * If you disable DNSSEC, you remove the DNS records at the registrar. When you disable the DNS role, the system this function. ### Enable DNSSEC - [GET /DNSSEC/enable_dnssec](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/enable_dnssec.md): This function enables DNSSEC on the domain. * After you enable DNSSEC on the domain, you add the DNS records to your registrar. * You modify the DNSSEC security key. To make any changes, you disable (and delete) and re-create the DNSSEC security key. When you disable the DNS role, the system this function. ### Export DNSKEY record value - [GET /DNSSEC/export_zone_dnskey](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/export_zone_dnskey.md): This function exports a domain's DNSKEY record value. When you disable the _DNS_ role, the system this function. ### Export DNSSEC security key - [GET /DNSSEC/export_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/export_zone_key.md): This function exports a DNSSEC security key. When you disable the DNS role, the system this function. ### Return domain's DS records - [GET /DNSSEC/fetch_ds_records](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/fetch_ds_records.md): This function fetches a domain's Delegation of Signing (DS) records. When you disable the DNS role, the system this function. ### Add DNSSEC security key - [GET /DNSSEC/import_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/import_zone_key.md): This function imports a DNSSEC security key. When you disable the DNS role, the system this function. ### Remove DNSSEC security key - [GET /DNSSEC/remove_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/remove_zone_key.md): This function removes a DNSSEC security key. When you disable the DNS role, the system this function. ### Update domain to use NSEC3 - [GET /DNSSEC/set_nsec3](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/set_nsec3.md): This function configures the domain to use Next Secure Record 3 (NSEC3) semantics. When you disable the DNS role, the system this function. ### Update domain to use NSEC - [GET /DNSSEC/unset_nsec3](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/unset_nsec3.md): This function configures the domain to use Next Secure Record (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics. When you disable the DNS role, the system this function. ## DNS Security DNS / DNS Security ### Enable DNSSEC security key - [GET /DNSSEC/activate_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/activate_zone_key.md): This function activates a DNSSEC security key. When you disable the DNS role, the system this function. ### Create DNSSEC security key - [GET /DNSSEC/add_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/add_zone_key.md): This function generates a DNSSEC zone key for a domain. * After you enable DNSSEC on the domain, you add the DS records to your registrar. * You modify the DNSSEC security key. To make any changes, you disable (and delete) and re-create the DNSSEC security key. When you disable the DNS role, the system this function. ### Disable DNSSEC security key - [GET /DNSSEC/deactivate_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/deactivate_zone_key.md): This function deactivates a DNSSEC security key. When you disable the role, the system this function. ### Disable DNSSEC - [GET /DNSSEC/disable_dnssec](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/disable_dnssec.md): This function disables DNSSEC on the domain. * This action is . If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup. * If you disable DNSSEC, you remove the DNS records at the registrar. When you disable the DNS role, the system this function. ### Enable DNSSEC - [GET /DNSSEC/enable_dnssec](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/enable_dnssec.md): This function enables DNSSEC on the domain. * After you enable DNSSEC on the domain, you add the DNS records to your registrar. * You modify the DNSSEC security key. To make any changes, you disable (and delete) and re-create the DNSSEC security key. When you disable the DNS role, the system this function. ### Export DNSKEY record value - [GET /DNSSEC/export_zone_dnskey](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/export_zone_dnskey.md): This function exports a domain's DNSKEY record value. When you disable the _DNS_ role, the system this function. ### Export DNSSEC security key - [GET /DNSSEC/export_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/export_zone_key.md): This function exports a DNSSEC security key. When you disable the DNS role, the system this function. ### Return domain's DS records - [GET /DNSSEC/fetch_ds_records](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/fetch_ds_records.md): This function fetches a domain's Delegation of Signing (DS) records. When you disable the DNS role, the system this function. ### Add DNSSEC security key - [GET /DNSSEC/import_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/import_zone_key.md): This function imports a DNSSEC security key. When you disable the DNS role, the system this function. ### Remove DNSSEC security key - [GET /DNSSEC/remove_zone_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/remove_zone_key.md): This function removes a DNSSEC security key. When you disable the DNS role, the system this function. ### Update domain to use NSEC3 - [GET /DNSSEC/set_nsec3](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/set_nsec3.md): This function configures the domain to use Next Secure Record 3 (NSEC3) semantics. When you disable the DNS role, the system this function. ### Update domain to use NSEC - [GET /DNSSEC/unset_nsec3](https://api.docs.cpanel.net/specifications/cpanel.openapi/dns-security/unset_nsec3.md): This function configures the domain to use Next Secure Record (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics. When you disable the DNS role, the system this function. ## DynamicDNS The DynamicDNS module for UAPI. ### Create Dynamic DNS domain - [GET /DynamicDNS/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-create.md): This function creates a Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Delete Dynamic DNS domain - [GET /DynamicDNS/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-delete.md): This function deletes an existing Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Return Dynamic DNS domains - [GET /DynamicDNS/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-list.md): This function lists the user’s Dynamic DNS (DDNS) domains. When you disable the _DNS_ role, the system disables this function. ### Update Dynamic DNS domain ID - [GET /DynamicDNS/recreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-recreate.md): This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Update Dynamic DNS domain description - [GET /DynamicDNS/set_description](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-set_description.md): This function sets the description on a user’s Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ## Dynamic DNS DNS / Dynamic DNS ### Create Dynamic DNS domain - [GET /DynamicDNS/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-create.md): This function creates a Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Delete Dynamic DNS domain - [GET /DynamicDNS/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-delete.md): This function deletes an existing Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Return Dynamic DNS domains - [GET /DynamicDNS/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-list.md): This function lists the user’s Dynamic DNS (DDNS) domains. When you disable the _DNS_ role, the system disables this function. ### Update Dynamic DNS domain ID - [GET /DynamicDNS/recreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-recreate.md): This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ### Update Dynamic DNS domain description - [GET /DynamicDNS/set_description](https://api.docs.cpanel.net/specifications/cpanel.openapi/dynamic-dns/dynamicdns-set_description.md): This function sets the description on a user’s Dynamic DNS (DDNS) domain. When you disable the _DNS_ role, the system disables this function. ## Email DNS Settings DNS / Email DNS Settings ### Create mail exchanger record - [GET /Email/add_mx](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/add_mx.md): This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our Email Routing Configuration documentation. When you disable the role, the system this function ### Update mail exchanger record - [GET /Email/change_mx](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/change_mx.md): This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our Email Routing Configuration documentation. When you disable the role, the system this function. ### Delete mail exchanger record - [GET /Email/delete_mx](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/delete_mx.md): This function deletes a Mail Exchanger (MX) record. For more information about MX record settings, read our Email Routing Configuration documentation. When you disable the DNS role, the system this function. ### Return mail exchanger records - [GET /Email/list_mxs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/list_mxs.md): This function lists Mail Exchanger (MX) records. When you disable the role, the system this function. ### Apply DMARC records to domains. - [GET /EmailAuth/apply_dmarc](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::apply_dmarc.md): This function applies a DMARC record to the specified domain(s) ### Remove domains' DKIM records - [GET /EmailAuth/disable_dkim](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/disable_dkim.md): This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains. ### Enable domains' DKIM records - [GET /EmailAuth/enable_dkim](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/enable_dkim.md): This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains. If a DKIM record does exist on the server, this function will install a new DKIM record. ### Validate domains' DKIM private keys - [GET /EmailAuth/ensure_dkim_keys_exist](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/ensure_dkim_keys_exist.md): This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains. * If an existing DKIM key does meet the server's security requirements, the system replaces the existing DKIM key. * If no DKIM key exists, the system creates a new key for the domain. ### Return domains' DKIM private keys - [GET /EmailAuth/fetch_dkim_private_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/fetch_dkim_private_keys.md): This function returns a domain's installed DKIM private key in Privacy-Enhanced Mail (PEM) format. We recommend that you protect your private key. If others obtain your private DKIM key, they could sign emails and impersonate you as a sender. ### Add domains' DKIM record keys - [GET /EmailAuth/install_dkim_private_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/install_dkim_private_keys.md): This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records. * This function does update the local DNS server's records. * If the local DNS server is authoritative for the domain's DNS records, use the UAPI function to update the local DNS server's DNS records. * We recommend that you use the UAPI and in a batch UAPI call. ### Add domains' SPF records - [GET /EmailAuth/install_spf_records](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/install_spf_records.md): This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server. ### Remove DMARC record from domain(s) - [GET /EmailAuth/remove_dmarc](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::remove_dmarc.md): This function removes the DMARC record for domains. ### Validate domains' DKIM records - [GET /EmailAuth/validate_current_dkims](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_dkims.md): This function retrieves and checks the DomainKeys Identified Mail (DKIM) records for one or more domains. ### Validate domains' DMARC records - [GET /EmailAuth/validate_current_dmarcs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::validate_current_dmarcs.md): This function checks the validity of the current DMARC record for one or more domains. ### Validate domains' PTR records - [GET /EmailAuth/validate_current_ptrs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_ptrs.md): This function validates the pointer records (PTR) for IPv4 and IPv6 addresses that the account's domains send mail from. It retrieves the PTR records for each IP address and determines which of the domain's IP addresses send mail. It then validates the PTR records for each IP address and validates the A or AAAA records pointing to each domain. This function also ensures that at least one of that domain's A or AAAA records points back to the IP address. ### Validate domains' SPF records - [GET /EmailAuth/validate_current_spfs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_spfs.md): This function retrieves the the Sender Policy Framework (SPF) records for one or more domains. ## EmailAuth The EmailAuth module for UAPI. ### Apply DMARC records to domains. - [GET /EmailAuth/apply_dmarc](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::apply_dmarc.md): This function applies a DMARC record to the specified domain(s) ### Remove domains' DKIM records - [GET /EmailAuth/disable_dkim](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/disable_dkim.md): This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains. ### Enable domains' DKIM records - [GET /EmailAuth/enable_dkim](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/enable_dkim.md): This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains. If a DKIM record does exist on the server, this function will install a new DKIM record. ### Validate domains' DKIM private keys - [GET /EmailAuth/ensure_dkim_keys_exist](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/ensure_dkim_keys_exist.md): This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains. * If an existing DKIM key does meet the server's security requirements, the system replaces the existing DKIM key. * If no DKIM key exists, the system creates a new key for the domain. ### Return domains' DKIM private keys - [GET /EmailAuth/fetch_dkim_private_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/fetch_dkim_private_keys.md): This function returns a domain's installed DKIM private key in Privacy-Enhanced Mail (PEM) format. We recommend that you protect your private key. If others obtain your private DKIM key, they could sign emails and impersonate you as a sender. ### Add domains' DKIM record keys - [GET /EmailAuth/install_dkim_private_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/install_dkim_private_keys.md): This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records. * This function does update the local DNS server's records. * If the local DNS server is authoritative for the domain's DNS records, use the UAPI function to update the local DNS server's DNS records. * We recommend that you use the UAPI and in a batch UAPI call. ### Add domains' SPF records - [GET /EmailAuth/install_spf_records](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/install_spf_records.md): This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server. ### Remove DMARC record from domain(s) - [GET /EmailAuth/remove_dmarc](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::remove_dmarc.md): This function removes the DMARC record for domains. ### Validate domains' DKIM records - [GET /EmailAuth/validate_current_dkims](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_dkims.md): This function retrieves and checks the DomainKeys Identified Mail (DKIM) records for one or more domains. ### Validate domains' DMARC records - [GET /EmailAuth/validate_current_dmarcs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/emailauth::validate_current_dmarcs.md): This function checks the validity of the current DMARC record for one or more domains. ### Validate domains' PTR records - [GET /EmailAuth/validate_current_ptrs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_ptrs.md): This function validates the pointer records (PTR) for IPv4 and IPv6 addresses that the account's domains send mail from. It retrieves the PTR records for each IP address and determines which of the domain's IP addresses send mail. It then validates the PTR records for each IP address and validates the A or AAAA records pointing to each domain. This function also ensures that at least one of that domain's A or AAAA records points back to the IP address. ### Validate domains' SPF records - [GET /EmailAuth/validate_current_spfs](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-dns-settings/validate_current_spfs.md): This function retrieves the the Sender Policy Framework (SPF) records for one or more domains. ## Domain The Domain module for UAPI. ### Convert a temporary domain to a registered domain - [POST /Domain/convert_temporary_to_registered](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-convert_temporary_to_registered.md): This function converts a temporary domain into a registered domain and moves its document root files to the new document root location. * For more information about temporary domains, read our Temporary Domains documentation. * You cannot use this function to convert a cPanel account's main domain. ### Return whether a domain is temporary - [GET /Domain/is_temporary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-is_temporary_domain.md): This function determines whether a domain is temporary. For more information about temporary domains, read our Temporary Domains documentation. ### Convert a temporary domain to a registered domain - [POST /Domain/convert_temporary_to_registered](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-convert_temporary_to_registered.md): This function converts a temporary domain into a registered domain and moves its document root files to the new document root location. * For more information about temporary domains, read our Temporary Domains documentation. * You cannot use this function to convert a cPanel account's main domain. ### Return whether a domain is temporary - [GET /Domain/is_temporary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-is_temporary_domain.md): This function determines whether a domain is temporary. For more information about temporary domains, read our Temporary Domains documentation. ## Temporary Domains ### Convert a temporary domain to a registered domain - [POST /Domain/convert_temporary_to_registered](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-convert_temporary_to_registered.md): This function converts a temporary domain into a registered domain and moves its document root files to the new document root location. * For more information about temporary domains, read our Temporary Domains documentation. * You cannot use this function to convert a cPanel account's main domain. ### Return whether a domain is temporary - [GET /Domain/is_temporary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-is_temporary_domain.md): This function determines whether a domain is temporary. For more information about temporary domains, read our Temporary Domains documentation. ### Convert a temporary domain to a registered domain - [POST /Domain/convert_temporary_to_registered](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-convert_temporary_to_registered.md): This function converts a temporary domain into a registered domain and moves its document root files to the new document root location. * For more information about temporary domains, read our Temporary Domains documentation. * You cannot use this function to convert a cPanel account's main domain. ### Return whether a domain is temporary - [GET /Domain/is_temporary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain/domain-is_temporary_domain.md): This function determines whether a domain is temporary. For more information about temporary domains, read our Temporary Domains documentation. ## Mime The Mime module for UAPI. ### Enable hotlink protection - [GET /Mime/add_hotlink](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/add_hotlink.md): This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them. When you disable the WebServer role, the system this function. ### Disable hotlink protection - [GET /Mime/delete_hotlink](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/delete_hotlink.md): This function removes hotlink protection. When you disable the Web Server role, the system this function. ### Return domains with hotlink protection - [GET /Mime/list_hotlinks](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/list_hotlinks.md): This function lists domains with hotlink protection. When you the Web Server role, the system this function. ### Add redirect to domain - [GET /Mime/add_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/add_redirect.md): This function adds a redirect to a domain. When you disable the role, the system this function. ### Remove redirect from domain - [GET /Mime/delete_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/delete_redirect.md): This function removes a redirect from a domain. When you disable the Web Server role, the system this function. ### Return redirect URL for domain - [GET /Mime/get_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/get_redirect.md): This function retrieves a redirection URL for a domain. ### Return .htaccess files' redirects - [GET /Mime/list_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/list_redirects.md): This function lists the redirects in an account's .htaccess files. When you disable the Web Server role, the system this function. ### Add web server MIME type handler - [GET /Mime/add_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/add_handler.md): This function creates an Apache MIME type handler for a file extension. When you disable the Web Server role, the system this function. ### Remove web server MIME type handler - [GET /Mime/delete_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/delete_handler.md): This function deletes an Apache MIME type handler. When you disable the WebServer role, the system this function. ### Return web server's MIME handlers - [GET /Mime/list_handlers](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/list_handlers.md): This function lists all of Apache's MIME handlers. When you disable the WebServer role, the system this function. ### Return redirect information - [GET /Mime/redirect_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/redirect_info.md): This function retrieves redirect information for a URL or . When you disable the Web Server role, the system this function. ### Add MIME type to web server - [GET /Mime/add_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/add_mime.md): This function adds a MIME type to Apache. When you disable the Web Server role, the system this function. ### Remove MIME type from web server - [GET /Mime/delete_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/delete_mime.md): This function removes a MIME type from Apache. When you disable the WebServer role, the system this function. ### Return web server's MIME types - [GET /Mime/list_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/list_mime.md): This function lists all of Apache's MIME types. This function does list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays custom MIME types. When you disable the Web Server role, the system this function. ## Direct Link Protection (Hotlink) Domain Management / Direct Link Protection (Hotlink) ### Enable hotlink protection - [GET /Mime/add_hotlink](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/add_hotlink.md): This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them. When you disable the WebServer role, the system this function. ### Disable hotlink protection - [GET /Mime/delete_hotlink](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/delete_hotlink.md): This function removes hotlink protection. When you disable the Web Server role, the system this function. ### Return domains with hotlink protection - [GET /Mime/list_hotlinks](https://api.docs.cpanel.net/specifications/cpanel.openapi/direct-link-protection-(hotlink)/list_hotlinks.md): This function lists domains with hotlink protection. When you the Web Server role, the system this function. ## DomainInfo The DomainInfo module for UAPI. ### Return all domains' hosting configuration - [GET /DomainInfo/domains_data](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/domains_data.md): This function lists user data for the cPanel account's domains. This function retrieves data from the file, where represents the cPanel account username and represents the domain. For this reason, actual output may not contain all of the returns that this document lists. ### Return cPanel account's domains - [GET /DomainInfo/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/list_domains.md): This function lists the cPanel account's domains. For this function to succeed, the file (where represents the authenticated user) possess the correct permissions. If a permissions error occurs, this function returns blank values for of its returns and does return an error message. ### Return built-in subdomain aliases - [GET /DomainInfo/main_domain_builtin_subdomain_aliases](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/main_domain_builtin_subdomain_aliases.md): This function returns the built-in subdomain aliases for an account's main domain. This function retrieves data from the file, where represents the cPanel account username and represents the domain. For this reason, actual output may not contain all of the returns that this document lists. ### Return the cPanel account's primary domain - [GET /DomainInfo/primary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/primary_domain.md): This function returns the cPanel account's main domain. ### Return domain's hosting configuration - [GET /DomainInfo/single_domain_data](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/single_domain_data.md): This function lists user data for a domain. This function retrieves data from the file, where represents the cPanel account username and represents the domain. * Because aliases (parked domains) do use a user data file, this function query information for aliases. To retrieve information for an alias, specify the associated main or addon domain. * Due to differences in user data files, the function's actual output may not contain all of the returns that this document lists. ## Domain Information Domain Management / Domain Information ### Return all domains' hosting configuration - [GET /DomainInfo/domains_data](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/domains_data.md): This function lists user data for the cPanel account's domains. This function retrieves data from the file, where represents the cPanel account username and represents the domain. For this reason, actual output may not contain all of the returns that this document lists. ### Return cPanel account's domains - [GET /DomainInfo/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/list_domains.md): This function lists the cPanel account's domains. For this function to succeed, the file (where represents the authenticated user) possess the correct permissions. If a permissions error occurs, this function returns blank values for of its returns and does return an error message. ### Return built-in subdomain aliases - [GET /DomainInfo/main_domain_builtin_subdomain_aliases](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/main_domain_builtin_subdomain_aliases.md): This function returns the built-in subdomain aliases for an account's main domain. This function retrieves data from the file, where represents the cPanel account username and represents the domain. For this reason, actual output may not contain all of the returns that this document lists. ### Return the cPanel account's primary domain - [GET /DomainInfo/primary_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/primary_domain.md): This function returns the cPanel account's main domain. ### Return domain's hosting configuration - [GET /DomainInfo/single_domain_data](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-information/single_domain_data.md): This function lists user data for a domain. This function retrieves data from the file, where represents the cPanel account username and represents the domain. * Because aliases (parked domains) do use a user data file, this function query information for aliases. To retrieve information for an alias, specify the associated main or addon domain. * Due to differences in user data files, the function's actual output may not contain all of the returns that this document lists. ## Domain Redirection Domain Management / Domain Redirection ### Add redirect to domain - [GET /Mime/add_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/add_redirect.md): This function adds a redirect to a domain. When you disable the role, the system this function. ### Remove redirect from domain - [GET /Mime/delete_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/delete_redirect.md): This function removes a redirect from a domain. When you disable the Web Server role, the system this function. ### Return redirect URL for domain - [GET /Mime/get_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/get_redirect.md): This function retrieves a redirection URL for a domain. ### Return .htaccess files' redirects - [GET /Mime/list_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-redirection/list_redirects.md): This function lists the redirects in an account's .htaccess files. When you disable the Web Server role, the system this function. ## SubDomain The SubDomain module for UAPI. ### Create subdomain - [GET /SubDomain/addsubdomain](https://api.docs.cpanel.net/specifications/cpanel.openapi/subdomain/addsubdomain.md): This function creates a subdomain. When you disable the Web Server role, the system this function. ## WebVhosts The WebVhosts module for UAPI. ### Return virtual host names for domains - [GET /WebVhosts/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/virtual-host-information/webvhosts::list_domains.md): This function lists virtual host names for each domain. ### Return domains that allow SSL certificate purchase - [GET /WebVhosts/list_ssl_capable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/virtual-host-information/list_ssl_capable_domains.md): This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable service subdomains. ## Virtual Host Information Domain Management / Virtual Host Information ### Return virtual host names for domains - [GET /WebVhosts/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/virtual-host-information/webvhosts::list_domains.md): This function lists virtual host names for each domain. ### Return domains that allow SSL certificate purchase - [GET /WebVhosts/list_ssl_capable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/virtual-host-information/list_ssl_capable_domains.md): This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable service subdomains. ## CSVImport The CSVImport module for UAPI. ### Import email accounts from CSV file - [GET /CSVImport/doimport](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/csvimport::doimport.md): This function imports email accounts from an already uploaded CSV file. ## Email Accounts Email / Email Accounts ### Import email accounts from CSV file - [GET /CSVImport/doimport](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/csvimport::doimport.md): This function imports email accounts from an already uploaded CSV file. ### Return current user's account name - [GET /Email/account_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/account_name.md): This function returns the provided value. This function works with other functions to display form data within a user interface. If you call this function from a Webmail session URL, the system will access data for that email account. When you disable the role, the system this function. ### Create email account's autoresponder - [GET /Email/add_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/add_auto_responder.md): This function creates an autoresponder for an email account. When you disable the role, the system this function. ### Create email address - [GET /Email/add_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/add_pop.md): This function creates an email address. Receive Mail* role, the system this function. Reset Password* feature. * You URI-encode values when using the CLI. ### Return mail directory's subdirectories and files - [GET /Email/browse_mailbox](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/browse_mailbox.md): This function lists the mail directory's subdirectories (boxes) and files. When you disable the role, the system this function. If you do not use any input parameters, the function returns a list of items in the cPanel account's main mail directory. ### Return cPanel account's autoresponders total - [GET /Email/count_auto_responders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/count_auto_responders.md): This function returns the number of autoresponders for every email address on a cPanel account. When you disable the role, the system this function. ### Return cPanel account's email account total - [GET /Email/count_pops](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/count_pops.md): This function returns the number of email accounts for a cPanel account. When you disable the role, the system this function. ### Delete email account's autoresponder - [GET /Email/delete_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_auto_responder.md): This function deletes an autoresponder. When you disable the role, the system this function. ### Delete email account's outgoing messages - [GET /Email/delete_held_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_held_messages.md): This function deletes all outbound email messages held in the mail queue for the specified email account. When you disable the role, the system this function. ### Delete email address - [GET /Email/delete_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_pop.md): This function deletes an email address. When you disable the role, the system this function. ### Send email client settings to an email address - [GET /Email/dispatch_client_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/dispatch_client_settings.md): This function sends an email account's client settings to an email address. When you disable the Receive Mail role, the system this function. ### Update email account's quota - [GET /Email/edit_pop_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/edit_pop_quota.md): This function changes an email address's quota. ### Return email account's autoresponder information - [GET /Email/get_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_auto_responder.md): This function retrieves autoresponder information. When you disable the Receive Mail role, the system this function. ### Return email account's client settings - [GET /Email/get_client_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_client_settings.md): This function retrieves an email account's client settings. When you disable the Receive Mail role, the system this function. ### Return email account's default email quota - [GET /Email/get_default_email_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_default_email_quota.md): This function retrieves the account's default email quota size, in bytes format. When you disable the Receive Mail role, the system this function. ### Return email account's default email quota in MiB - [GET /Email/get_default_email_quota_mib](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_default_email_quota_mib.md): This function retrieves the account's default email quota size in mebibytes (MiB). When you disable the Receive Mail role, the system this function. ### Return email account's disk usage - [GET /Email/get_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_disk_usage.md): This function retrieves the disk space that an email account uses. When you disable the Receive Mail role, the system this function. ### Return email account's outgoing message count - [GET /Email/get_held_message_count](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_held_message_count.md): This function returns the count of outbound email messages held in the mail queue for the specified email account. When you disable the Receive Mail role, the system this function. ### Return primary email account's disk usage - [GET /Email/get_main_account_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_main_account_disk_usage.md): This function returns the disk space that the main account uses. When you disable the Receive Mail role, the system this function. ### Return primary email account's disk usage in bytes - [GET /Email/get_main_account_disk_usage_bytes](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_main_account_disk_usage_bytes.md): This function returns the disk space that the cPanel account uses. When you disable the Receive Mail role, the system this function. ### Return email account's max quota size - [GET /Email/get_max_email_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_max_email_quota.md): This function retrieves the account's maximum email quota size, in bytes format. When you disable the Receive Mail role, the system this function. ### Return email account's max quota size in MiB - [GET /Email/get_max_email_quota_mib](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_max_email_quota_mib.md): This function retrieves the account's maximum email account quota size, in Mebibytes (MiB) format. When you disable the Receive Mail role, the system this function. ### Return email account's quota - [GET /Email/get_pop_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_pop_quota.md): This function retrieves an email account's quota. When you disable the Receive Mail role, the system this function. ### Return email account's Webmail settings - [GET /Email/get_webmail_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_webmail_settings.md): This function retrieves an email account's Webmail settings. When you disable the _Receive Mail_ role, the system this function. ### Stop email account's outgoing mail - [GET /Email/hold_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/hold_outgoing.md): This function sets Exim's queue to not send outgoing mail from an email account. * To send all mail from the queue, use the UAPI function. * To reject outgoing mail and not place mail in a queue, use the UAPI function. * This function does hold local outgoing mail. ### Return domain's autoresponders - [GET /Email/list_auto_responders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_auto_responders.md): This function lists a domain's autoresponders. When you disable the role, the system this function. ### Return domain's default email address - [GET /Email/list_default_address](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_default_address.md): This function retrieves a domain's default address. When you disable the role, the system this function. ### Return cPanel account's mail domains - [GET /Email/list_mail_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_mail_domains.md): This function lists the account's mail domains. When you disable the role, the system this function. This function returns the account's main domain first. By default, temporary domains (*.cpanel.site) are excluded. Use the parameter to include them. ### Return email accounts - [GET /Email/list_pops](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_pops.md): This function lists the cPanel account's email accounts. When you disable the role, the system this function. ### Return email accounts with disk information - [GET /Email/list_pops_with_disk](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_pops_with_disk.md): This function lists the cPanel account's email accounts with disk information. When you disable the role, the system this function. ### Update email account password - [GET /Email/passwd_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/passwd_pop.md): This function changes an email account's password. When you disable the Receive Mail role, the system this function. ### Start email account outgoing mail - [GET /Email/release_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/release_outgoing.md): This function sends all of the outgoing mail from Exim's queue for an email account. To set Exim to queue all outgoing mail for an email account, use the UAPI function. ### Create default email address - [GET /Email/set_default_address](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/set_default_address.md): This function configures a default (catchall) email address. : When you disable the Mail Receive role, the system this function. ### Add manual MX redirection - [GET /Email/set_manual_mx_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/set_manual_mx_redirects.md): This function lets you create a manual Exim mail exchanger (MX) redirect for a domain. An MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS). This function adds the manual redirect entries to the file. To remove a domain's manual MX redirection, use the UAPI Email function. ### Stop cPanel account IMAP and POP3 connections - [GET /Email/terminate_mailbox_sessions](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/email-terminate_mailbox_sessions.md): This function terminates all IMAP and POP3 connections for a cPanel account. This function ends connections for every email address, which includes the default address. ### Run email delivery route trace - [GET /Email/trace_delivery](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/trace_delivery.md): This function traces the email delivery route to an email account. ### Remove manual MX redirection - [GET /Email/unset_manual_mx_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/unset_manual_mx_redirects.md): This function lets you create a manual Exim mail exchanger (MX) redirect for a domain. An MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS). This function adds the manual redirect entries to the file. To remove a domain's manual MX redirection, use the UAPI Email function. ### Validate email account password - [GET /Email/verify_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/verify_password.md): This function verifies the password for an email account. When you disable the Receive Mail role, the system this function. ## Email The Email module for UAPI. ### Return current user's account name - [GET /Email/account_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/account_name.md): This function returns the provided value. This function works with other functions to display form data within a user interface. If you call this function from a Webmail session URL, the system will access data for that email account. When you disable the role, the system this function. ### Create email account's autoresponder - [GET /Email/add_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/add_auto_responder.md): This function creates an autoresponder for an email account. When you disable the role, the system this function. ### Create email address - [GET /Email/add_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/add_pop.md): This function creates an email address. Receive Mail* role, the system this function. Reset Password* feature. * You URI-encode values when using the CLI. ### Return mail directory's subdirectories and files - [GET /Email/browse_mailbox](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/browse_mailbox.md): This function lists the mail directory's subdirectories (boxes) and files. When you disable the role, the system this function. If you do not use any input parameters, the function returns a list of items in the cPanel account's main mail directory. ### Return cPanel account's autoresponders total - [GET /Email/count_auto_responders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/count_auto_responders.md): This function returns the number of autoresponders for every email address on a cPanel account. When you disable the role, the system this function. ### Return cPanel account's email account total - [GET /Email/count_pops](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/count_pops.md): This function returns the number of email accounts for a cPanel account. When you disable the role, the system this function. ### Delete email account's autoresponder - [GET /Email/delete_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_auto_responder.md): This function deletes an autoresponder. When you disable the role, the system this function. ### Delete email account's outgoing messages - [GET /Email/delete_held_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_held_messages.md): This function deletes all outbound email messages held in the mail queue for the specified email account. When you disable the role, the system this function. ### Delete email address - [GET /Email/delete_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/delete_pop.md): This function deletes an email address. When you disable the role, the system this function. ### Send email client settings to an email address - [GET /Email/dispatch_client_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/dispatch_client_settings.md): This function sends an email account's client settings to an email address. When you disable the Receive Mail role, the system this function. ### Update email account's quota - [GET /Email/edit_pop_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/edit_pop_quota.md): This function changes an email address's quota. ### Return email account's autoresponder information - [GET /Email/get_auto_responder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_auto_responder.md): This function retrieves autoresponder information. When you disable the Receive Mail role, the system this function. ### Return email account's client settings - [GET /Email/get_client_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_client_settings.md): This function retrieves an email account's client settings. When you disable the Receive Mail role, the system this function. ### Return email account's default email quota - [GET /Email/get_default_email_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_default_email_quota.md): This function retrieves the account's default email quota size, in bytes format. When you disable the Receive Mail role, the system this function. ### Return email account's default email quota in MiB - [GET /Email/get_default_email_quota_mib](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_default_email_quota_mib.md): This function retrieves the account's default email quota size in mebibytes (MiB). When you disable the Receive Mail role, the system this function. ### Return email account's disk usage - [GET /Email/get_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_disk_usage.md): This function retrieves the disk space that an email account uses. When you disable the Receive Mail role, the system this function. ### Return email account's outgoing message count - [GET /Email/get_held_message_count](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_held_message_count.md): This function returns the count of outbound email messages held in the mail queue for the specified email account. When you disable the Receive Mail role, the system this function. ### Return primary email account's disk usage - [GET /Email/get_main_account_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_main_account_disk_usage.md): This function returns the disk space that the main account uses. When you disable the Receive Mail role, the system this function. ### Return primary email account's disk usage in bytes - [GET /Email/get_main_account_disk_usage_bytes](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_main_account_disk_usage_bytes.md): This function returns the disk space that the cPanel account uses. When you disable the Receive Mail role, the system this function. ### Return email account's max quota size - [GET /Email/get_max_email_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_max_email_quota.md): This function retrieves the account's maximum email quota size, in bytes format. When you disable the Receive Mail role, the system this function. ### Return email account's max quota size in MiB - [GET /Email/get_max_email_quota_mib](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_max_email_quota_mib.md): This function retrieves the account's maximum email account quota size, in Mebibytes (MiB) format. When you disable the Receive Mail role, the system this function. ### Return email account's quota - [GET /Email/get_pop_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_pop_quota.md): This function retrieves an email account's quota. When you disable the Receive Mail role, the system this function. ### Return email account's Webmail settings - [GET /Email/get_webmail_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/get_webmail_settings.md): This function retrieves an email account's Webmail settings. When you disable the _Receive Mail_ role, the system this function. ### Stop email account's outgoing mail - [GET /Email/hold_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/hold_outgoing.md): This function sets Exim's queue to not send outgoing mail from an email account. * To send all mail from the queue, use the UAPI function. * To reject outgoing mail and not place mail in a queue, use the UAPI function. * This function does hold local outgoing mail. ### Return domain's autoresponders - [GET /Email/list_auto_responders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_auto_responders.md): This function lists a domain's autoresponders. When you disable the role, the system this function. ### Return domain's default email address - [GET /Email/list_default_address](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_default_address.md): This function retrieves a domain's default address. When you disable the role, the system this function. ### Return cPanel account's mail domains - [GET /Email/list_mail_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_mail_domains.md): This function lists the account's mail domains. When you disable the role, the system this function. This function returns the account's main domain first. By default, temporary domains (*.cpanel.site) are excluded. Use the parameter to include them. ### Return email accounts - [GET /Email/list_pops](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_pops.md): This function lists the cPanel account's email accounts. When you disable the role, the system this function. ### Return email accounts with disk information - [GET /Email/list_pops_with_disk](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/list_pops_with_disk.md): This function lists the cPanel account's email accounts with disk information. When you disable the role, the system this function. ### Update email account password - [GET /Email/passwd_pop](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/passwd_pop.md): This function changes an email account's password. When you disable the Receive Mail role, the system this function. ### Start email account outgoing mail - [GET /Email/release_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/release_outgoing.md): This function sends all of the outgoing mail from Exim's queue for an email account. To set Exim to queue all outgoing mail for an email account, use the UAPI function. ### Create default email address - [GET /Email/set_default_address](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/set_default_address.md): This function configures a default (catchall) email address. : When you disable the Mail Receive role, the system this function. ### Add manual MX redirection - [GET /Email/set_manual_mx_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/set_manual_mx_redirects.md): This function lets you create a manual Exim mail exchanger (MX) redirect for a domain. An MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS). This function adds the manual redirect entries to the file. To remove a domain's manual MX redirection, use the UAPI Email function. ### Stop cPanel account IMAP and POP3 connections - [GET /Email/terminate_mailbox_sessions](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/email-terminate_mailbox_sessions.md): This function terminates all IMAP and POP3 connections for a cPanel account. This function ends connections for every email address, which includes the default address. ### Run email delivery route trace - [GET /Email/trace_delivery](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/trace_delivery.md): This function traces the email delivery route to an email account. ### Remove manual MX redirection - [GET /Email/unset_manual_mx_redirects](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/unset_manual_mx_redirects.md): This function lets you create a manual Exim mail exchanger (MX) redirect for a domain. An MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS). This function adds the manual redirect entries to the file. To remove a domain's manual MX redirection, use the UAPI Email function. ### Validate email account password - [GET /Email/verify_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-accounts/verify_password.md): This function verifies the password for an email account. When you disable the Receive Mail role, the system this function. ### Return cPanel account's email filters total - [GET /Email/count_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/count_filters.md): This function returns the number of email filters for every email address on a cPanel account. When you disable the role or the feature, the system this function. For more information, read our How to Use Server Profiles documentation. ### Delete email account's email filter - [GET /Email/delete_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/delete_filter.md): This function deletes an email filter. When you disable the role, the system this function. ### Disable email filter for email account - [GET /Email/disable_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/disable_filter.md): This function disables an email filter. When you disable the role, the system this function. ### Enable email filter for email account - [GET /Email/enable_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/enable_filter.md): This function enables an email filter. When you disable the Receive Mail role, the system this function. ### Return email filter's information - [GET /Email/get_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/get_filter.md): This function retrieves an email filter's information. When you disable the Receive Mail role, the system this function. ### Return account-level email filters - [GET /Email/list_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_filters.md): This function lists account-level mail filters. For more information about Exim filters, read Exim’s documentation. : When you disable the Mail Receive role, the system this function. ### Return domains with domain-level email filters - [GET /Email/list_filters_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_filters_backups.md): This function lists all of the cPanel account's domains that use domain-level filters. When you disable the role, the system this function. ### Return system-level email filter file information - [GET /Email/list_system_filter_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_system_filter_info.md): This function retrieves a file that contains system-level filter information. When you disable the role, the system this function. ### Update email address's email filter order - [GET /Email/reorder_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/reorder_filters.md): This function modifies the filter order for an email address. For more information about Exim filters, read Exim's documentation. When you disable the _Receive Mail_ role, the system this function. ### Create email filter - [GET /Email/store_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/store_filter.md): This function creates a new email filter. For more information about Exim filters, read Exim's documentation. When you disable the role, the system this function. ### Create multiple rules You may create up to 4,096 separate sets of conditions in one filter. To do this, append numbers to the parameter names. To create a filter with two sets of actions and conditions, use the following parameters: * Assign the information for the first filter rule to the , , , , , and parameters. * Assign the information for the second filter rule to the , , , , , and parameters. To create a filter that uses one set of actions but two sets of conditions, use the following parameters: * Assign the actions to the and parameters. * Assign the first set of conditions to the , , , and parameters. * Assign the second set of conditions to the , , , and parameters. ### Run test for main domain email filters - [GET /Email/trace_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/trace_filter.md): This function tests mail filters. The function tests filters for the cPanel account's main domain, and only tests against the message's body. For more information about Exim filters, read Exim's documentation. If the domain or account does not contain a filter file, this function will fail. When you disable the Receive Mail role, the system this function. ### Create domain-level forwarder - [GET /Email/add_domain_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/add_domain_forwarder.md): This function creates a domain-level forwarder. When you disable the role, the system this function. ### Create email account forwarder - [GET /Email/add_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/add_forwarder.md): This function creates an email forwarder. When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation. ### Return cPanel account's mail forwarder total - [GET /Email/count_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/count_forwarders.md): This function returns the number of forwarders for every email address on a cPanel account. When you disable the role, the system this function. ### Delete domain-level forwarder - [GET /Email/delete_domain_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/delete_domain_forwarder.md): This function deletes a domain-level forwarder. When you disable the role, the system this function. ### Delete email account's email forwarder - [GET /Email/delete_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/delete_forwarder.md): This function deletes an email forwarder. When you disable the role, the system this function. ### Return domain-level forwarders - [GET /Email/list_domain_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_domain_forwarders.md): This function lists domain-level forwarders. When you disable the role, the system this function. ### Return domain's forwarders - [GET /Email/list_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_forwarders.md): This function lists a domain's forwarders. When you disable the role, the system this function. ### Return domains with domain-level forwarders - [GET /Email/list_forwarders_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_forwarders_backups.md): This function lists the domains with domain-level forwarders. When you disable the role, the system this function. ### Return BlackBerry FastMail support status - [GET /Email/check_fastmail](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/check_fastmail.md): This function checks whether BlackBerry® FastMail support is enabled. When you disable the role, the system this function. ### Disable cPanel account mailbox autocreation - [GET /Email/disable_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/disable_mailbox_autocreate.md): This function disables the system's ability to automatically create mailboxes for a cPanel account. When you the UAPI's function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in plus address format and that mailbox does exist. For example, receiving an email from the address creates the mailbox if the mailbox does not exist. ### Enable cPanel account mailbox autocreation - [GET /Email/enable_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/enable_mailbox_autocreate.md): This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist. To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function. ### Return server's supported character encodings - [GET /Email/fetch_charmaps](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/fetch_charmaps.md): This function lists the available character encodings. When you disable the Receive Mail role, the system this function. ### Start IMAP Full-Text Search scan for email account - [GET /Email/fts_rescan_mailbox](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/fts_rescan_mailbox.md): This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account. To enable this function, you install the plugin in WHM's interface (). For more information, read our install_dovecot_fts script documentation. When you disable the Receive Mail role, the system disables this function. ### Return mail server's supported character encodings - [GET /Email/get_charsets](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/get_charsets.md): This function lists character encodings that the mail server supports. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailbox autocreate status - [GET /Email/get_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/get_mailbox_autocreate.md): This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in plus address format. To enable or disable this functionality, use the UAPI's and functions. ### Return whether plaintext authentication is enabled - [GET /Email/has_plaintext_authentication](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/has_plaintext_authentication.md): This function checks whether plaintext authentication is enabled on the Dovecot mail server. When you disable the Receive Mail role, the system this function. ### Update Mail Exchanger type - [GET /Email/set_always_accept](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/set_always_accept.md): This function sets the Mail Exchanger (MX) type. This function affects the cPanel configuration. You configure the mail exchanger's DNS entry separately. When you disable the DNS role, the system this function. ### Return eximstats SQLite database status - [GET /Email/stats_db_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/stats_db_status.md): This function returns the status of the eximstats SQLite Database. When you disable the Receive Mail role, the system this function. ### Suspend email account incoming (SMTP) mail - [GET /Email/suspend_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_incoming.md): This function suspends incoming email for an account. The system will reject incoming email while the account is suspended. * The user can still log in to the email account. To suspend a user's ability to log in to, send mail from, and read their account, use the UAPI function. * Use the UAPI function to allow the account to receive email. When you disable the Receive Mail role, the system this function. ### Suspend email account login - [GET /Email/suspend_login](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_login.md): This function suspends a user's ability to log in to their email account. This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account. * When you suspend an account, the user's account still receives email. * To suspend incoming email for an account, use the UAPI function. * To remove the login suspension for an account, use the UAPI function. When you disable the Receive Mail role, the system this function. ### Suspend email account outgoing mail - [GET /Email/suspend_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_outgoing.md): This function rejects outgoing mail for a suspended email account. This function does  disable a user's login credentials or access permissions to their email account. * To suspend a user's login credentials and prevent authenticated connections to the email account, use the UAPI function. * To allow an email account to send mail, use the UAPI function. * To hold outgoing mail in Exim's queue, use the UAPI function. When you disable the Send Mail role, the system this function. ### Unsuspend email account incoming mail - [GET /Email/unsuspend_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_incoming.md): This function unsuspends incoming email for an email account. When you disable the Receive Mail role, the system this function. ### Unsuspend email account login - [GET /Email/unsuspend_login](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_login.md): This function restores a user's ability to log in to their email account. * To suspend a user's ability to log in, use the UAPI function. * To suspend incoming email for an account, use the UAPI function. When you disable the Receive Mail role, the system this function. ### Unsuspend email account outgoing mail - [GET /Email/unsuspend_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_outgoing.md): This function cancels the suspension action put in place by the UAPI function for outgoing mail for an email account. To suspend an email account and reject all outgoing mail, use the UAPI function. ### Create mailing list - [GET /Email/add_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/add_list.md): This function creates a Mailman mailing list. When you disable the role, the system this function. ### Add administrators to mailing list - [GET /Email/add_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/add_mailman_delegates.md): This function grants mailing list administrative privileges to users. When you disable the role, the system this function. ### Return cPanel account's mailing list total - [GET /Email/count_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/count_lists.md): This function returns the number of mailing lists for every email address on a cPanel account. When you disable the role, the system this function. ### Delete mailing list - [GET /Email/delete_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/delete_list.md): This function deletes a Mailman mailing list. When you disable the role, the system this function. ### Export cPanel account's Mailman mailing lists to a file - [GET /Email/export_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/export_lists.md): This function exports a cPanel account's Mailman mailing lists into a CSV file. This file is located in mail/exported_lists under the user's home directory. ### Create one-time password for a mailing list - [GET /Email/generate_mailman_otp](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/generate_mailman_otp.md): This function generates a one-time password (OTP) for a mailing list. The generated password expires after one use. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailing list disk usage - [GET /Email/get_lists_total_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/get_lists_total_disk_usage.md): This function returns the total disk usage for the mailing lists of a cPanel account. When you disable the Receive Mail role, the system this function. ### Return mailing list administrators - [GET /Email/get_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/get_mailman_delegates.md): This function lists a mailing list's administrators. When you disable the Receive Mail role, the system this function. ### Return email account's mailing list privileges - [GET /Email/has_delegated_mailman_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/has_delegated_mailman_lists.md): This function checks an account's administrative privileges on mailing lists. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailing lists - [GET /Email/list_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/list_lists.md): This function lists the account's Mailman mailing lists. ### Update mailing list password - [GET /Email/passwd_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/passwd_list.md): This function changes a mailing list's password. When you disable the _Receive Mail_ role, the system this function. ### Remove account mailing list admin privileges - [GET /Email/remove_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/remove_mailman_delegates.md): This function removes an account's mailing list administrative privileges. ### Update mailing list privacy options - [GET /Email/set_list_privacy_options](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/set_list_privacy_options.md): This function modifies a Mailman mailing list's privacy options. When you disable the Receive Mail role, the system this function. ### Update minimum spam score threshold value - [GET /Email/add_spam_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/add_spam_filter.md): This function sets a new minimum Apache SpamAssassin™ spam score threshold value. * To disable spam filtering, use the UAPI fuction. * For more information, read our Spam Filters documentation. Spam Filter* role, the system this function. ### Disable Apache SpamAssassin for cPanel account - [GET /Email/disable_spam_assassin](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_assassin.md): This function disables Apache SpamAssassin™ for a cPanel account. When you disable the role, the system this function. ### Disable spam box filtering auto-delete - [GET /Email/disable_spam_autodelete](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_autodelete.md): This function disables the Apache SpamAssassin™ auto-delete spam feature. When you disable the role, the system this function. ### Disable spam box filtering for cPanel account - [GET /Email/disable_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_box.md): This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account's inbox. * This function that your hosting provider enables Apache SpamAssassin™ on the server. * To spam box filtering, use the UAPI function. * For more information, read our Spam Filters documentation. When you disable the role, the system this function. ### Enable Apache SpamAssassin for cPanel account - [GET /Email/enable_spam_assassin](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/enable_spam_assassin.md): This function enables Apache SpamAssassin™ for the account. When you disable the Spam Filter role, the system this function. ### Enable spam box filtering for cPanel account - [GET /Email/enable_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/enable_spam_box.md): This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder. * This function that your hosting provider enables Apache SpamAssassin on the server. * To spam box filtering, use the UAPI function. * For more information, read our Spam Filters documentation. When you disable the Spam Filter role, the system this function. ### Return email account Apache SpamAssassin settings - [GET /Email/get_spam_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_spam_settings.md): This function retrieves the Apache SpamAssassin™ settings for the account. When you disable the SpamFilter role, the system this function. ## Email Filtering Email / Email Filtering ### Return cPanel account's email filters total - [GET /Email/count_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/count_filters.md): This function returns the number of email filters for every email address on a cPanel account. When you disable the role or the feature, the system this function. For more information, read our How to Use Server Profiles documentation. ### Delete email account's email filter - [GET /Email/delete_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/delete_filter.md): This function deletes an email filter. When you disable the role, the system this function. ### Disable email filter for email account - [GET /Email/disable_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/disable_filter.md): This function disables an email filter. When you disable the role, the system this function. ### Enable email filter for email account - [GET /Email/enable_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/enable_filter.md): This function enables an email filter. When you disable the Receive Mail role, the system this function. ### Return email filter's information - [GET /Email/get_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/get_filter.md): This function retrieves an email filter's information. When you disable the Receive Mail role, the system this function. ### Return account-level email filters - [GET /Email/list_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_filters.md): This function lists account-level mail filters. For more information about Exim filters, read Exim’s documentation. : When you disable the Mail Receive role, the system this function. ### Return domains with domain-level email filters - [GET /Email/list_filters_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_filters_backups.md): This function lists all of the cPanel account's domains that use domain-level filters. When you disable the role, the system this function. ### Return system-level email filter file information - [GET /Email/list_system_filter_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/list_system_filter_info.md): This function retrieves a file that contains system-level filter information. When you disable the role, the system this function. ### Update email address's email filter order - [GET /Email/reorder_filters](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/reorder_filters.md): This function modifies the filter order for an email address. For more information about Exim filters, read Exim's documentation. When you disable the _Receive Mail_ role, the system this function. ### Create email filter - [GET /Email/store_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/store_filter.md): This function creates a new email filter. For more information about Exim filters, read Exim's documentation. When you disable the role, the system this function. ### Create multiple rules You may create up to 4,096 separate sets of conditions in one filter. To do this, append numbers to the parameter names. To create a filter with two sets of actions and conditions, use the following parameters: * Assign the information for the first filter rule to the , , , , , and parameters. * Assign the information for the second filter rule to the , , , , , and parameters. To create a filter that uses one set of actions but two sets of conditions, use the following parameters: * Assign the actions to the and parameters. * Assign the first set of conditions to the , , , and parameters. * Assign the second set of conditions to the , , , and parameters. ### Run test for main domain email filters - [GET /Email/trace_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-filtering/trace_filter.md): This function tests mail filters. The function tests filters for the cPanel account's main domain, and only tests against the message's body. For more information about Exim filters, read Exim's documentation. If the domain or account does not contain a filter file, this function will fail. When you disable the Receive Mail role, the system this function. ## Email Forwarding Email / Email Forwarding ### Create domain-level forwarder - [GET /Email/add_domain_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/add_domain_forwarder.md): This function creates a domain-level forwarder. When you disable the role, the system this function. ### Create email account forwarder - [GET /Email/add_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/add_forwarder.md): This function creates an email forwarder. When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation. ### Return cPanel account's mail forwarder total - [GET /Email/count_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/count_forwarders.md): This function returns the number of forwarders for every email address on a cPanel account. When you disable the role, the system this function. ### Delete domain-level forwarder - [GET /Email/delete_domain_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/delete_domain_forwarder.md): This function deletes a domain-level forwarder. When you disable the role, the system this function. ### Delete email account's email forwarder - [GET /Email/delete_forwarder](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/delete_forwarder.md): This function deletes an email forwarder. When you disable the role, the system this function. ### Return domain-level forwarders - [GET /Email/list_domain_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_domain_forwarders.md): This function lists domain-level forwarders. When you disable the role, the system this function. ### Return domain's forwarders - [GET /Email/list_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_forwarders.md): This function lists a domain's forwarders. When you disable the role, the system this function. ### Return domains with domain-level forwarders - [GET /Email/list_forwarders_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-forwarding/list_forwarders_backups.md): This function lists the domains with domain-level forwarders. When you disable the role, the system this function. ## Email Server Information Email / Email Server Information ### Return BlackBerry FastMail support status - [GET /Email/check_fastmail](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/check_fastmail.md): This function checks whether BlackBerry® FastMail support is enabled. When you disable the role, the system this function. ### Disable cPanel account mailbox autocreation - [GET /Email/disable_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/disable_mailbox_autocreate.md): This function disables the system's ability to automatically create mailboxes for a cPanel account. When you the UAPI's function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in plus address format and that mailbox does exist. For example, receiving an email from the address creates the mailbox if the mailbox does not exist. ### Enable cPanel account mailbox autocreation - [GET /Email/enable_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/enable_mailbox_autocreate.md): This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist. To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function. ### Return server's supported character encodings - [GET /Email/fetch_charmaps](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/fetch_charmaps.md): This function lists the available character encodings. When you disable the Receive Mail role, the system this function. ### Start IMAP Full-Text Search scan for email account - [GET /Email/fts_rescan_mailbox](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/fts_rescan_mailbox.md): This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account. To enable this function, you install the plugin in WHM's interface (). For more information, read our install_dovecot_fts script documentation. When you disable the Receive Mail role, the system disables this function. ### Return mail server's supported character encodings - [GET /Email/get_charsets](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/get_charsets.md): This function lists character encodings that the mail server supports. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailbox autocreate status - [GET /Email/get_mailbox_autocreate](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/get_mailbox_autocreate.md): This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in plus address format. To enable or disable this functionality, use the UAPI's and functions. ### Return whether plaintext authentication is enabled - [GET /Email/has_plaintext_authentication](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/has_plaintext_authentication.md): This function checks whether plaintext authentication is enabled on the Dovecot mail server. When you disable the Receive Mail role, the system this function. ### Update Mail Exchanger type - [GET /Email/set_always_accept](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/set_always_accept.md): This function sets the Mail Exchanger (MX) type. This function affects the cPanel configuration. You configure the mail exchanger's DNS entry separately. When you disable the DNS role, the system this function. ### Return eximstats SQLite database status - [GET /Email/stats_db_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-server-information/stats_db_status.md): This function returns the status of the eximstats SQLite Database. When you disable the Receive Mail role, the system this function. ## Email Suspensions Email / Email Suspensions ### Suspend email account incoming (SMTP) mail - [GET /Email/suspend_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_incoming.md): This function suspends incoming email for an account. The system will reject incoming email while the account is suspended. * The user can still log in to the email account. To suspend a user's ability to log in to, send mail from, and read their account, use the UAPI function. * Use the UAPI function to allow the account to receive email. When you disable the Receive Mail role, the system this function. ### Suspend email account login - [GET /Email/suspend_login](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_login.md): This function suspends a user's ability to log in to their email account. This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account. * When you suspend an account, the user's account still receives email. * To suspend incoming email for an account, use the UAPI function. * To remove the login suspension for an account, use the UAPI function. When you disable the Receive Mail role, the system this function. ### Suspend email account outgoing mail - [GET /Email/suspend_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/suspend_outgoing.md): This function rejects outgoing mail for a suspended email account. This function does  disable a user's login credentials or access permissions to their email account. * To suspend a user's login credentials and prevent authenticated connections to the email account, use the UAPI function. * To allow an email account to send mail, use the UAPI function. * To hold outgoing mail in Exim's queue, use the UAPI function. When you disable the Send Mail role, the system this function. ### Unsuspend email account incoming mail - [GET /Email/unsuspend_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_incoming.md): This function unsuspends incoming email for an email account. When you disable the Receive Mail role, the system this function. ### Unsuspend email account login - [GET /Email/unsuspend_login](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_login.md): This function restores a user's ability to log in to their email account. * To suspend a user's ability to log in, use the UAPI function. * To suspend incoming email for an account, use the UAPI function. When you disable the Receive Mail role, the system this function. ### Unsuspend email account outgoing mail - [GET /Email/unsuspend_outgoing](https://api.docs.cpanel.net/specifications/cpanel.openapi/email-suspensions/unsuspend_outgoing.md): This function cancels the suspension action put in place by the UAPI function for outgoing mail for an email account. To suspend an email account and reject all outgoing mail, use the UAPI function. ## Chkservd The Chkservd module for UAPI. ### Return outgoing (SMTP) mail port - [GET /Chkservd/get_exim_ports](https://api.docs.cpanel.net/specifications/cpanel.openapi/mail-server-information/get_exim_ports.md): This function lists the ports on which Exim listens. ### Return outgoing mail (SMTP) SSL-secured port - [GET /Chkservd/get_exim_ports_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/mail-server-information/get_exim_ports_ssl.md): This function retrieves Exim's SSL port. ## Mail Server Information Email / Mail Server Information ### Return outgoing (SMTP) mail port - [GET /Chkservd/get_exim_ports](https://api.docs.cpanel.net/specifications/cpanel.openapi/mail-server-information/get_exim_ports.md): This function lists the ports on which Exim listens. ### Return outgoing mail (SMTP) SSL-secured port - [GET /Chkservd/get_exim_ports_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/mail-server-information/get_exim_ports_ssl.md): This function retrieves Exim's SSL port. ## Mailboxes The Mailboxes module for UAPI. ### Delete selected messages in mailbox - [GET /Mailboxes/expunge_mailbox_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/expunge_mailbox_messages.md): This function marks the selected mail messages as deleted. ### Delete selected messages in mailbox by GUID - [GET /Mailboxes/expunge_messages_for_mailbox_guid](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/expunge_messages_for_mailbox_guid.md): This function marks the selected mailbox's messages as deleted. ### Return cPanel account's mailbox status - [GET /Mailboxes/get_mailbox_status_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/get_mailbox_status_list.md): This function lists the account's mailbox size and globally unique identifier (GUID) by folder. ### Return if cPanel account's mailboxes use UTF-8 - [GET /Mailboxes/has_utf8_mailbox_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/has_utf8_mailbox_names.md): This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names. ### Enable or disable Webmail mailbox UTF-8 encoding - [GET /Mailboxes/set_utf8_mailbox_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/set_utf8_mailbox_names.md): This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user's email accounts. ## Mailbox Management Email / Mailbox Management ### Delete selected messages in mailbox - [GET /Mailboxes/expunge_mailbox_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/expunge_mailbox_messages.md): This function marks the selected mail messages as deleted. ### Delete selected messages in mailbox by GUID - [GET /Mailboxes/expunge_messages_for_mailbox_guid](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/expunge_messages_for_mailbox_guid.md): This function marks the selected mailbox's messages as deleted. ### Return cPanel account's mailbox status - [GET /Mailboxes/get_mailbox_status_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/get_mailbox_status_list.md): This function lists the account's mailbox size and globally unique identifier (GUID) by folder. ### Return if cPanel account's mailboxes use UTF-8 - [GET /Mailboxes/has_utf8_mailbox_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/has_utf8_mailbox_names.md): This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names. ### Enable or disable Webmail mailbox UTF-8 encoding - [GET /Mailboxes/set_utf8_mailbox_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailbox-management/set_utf8_mailbox_names.md): This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user's email accounts. ## Mailing Lists Email / Mailing Lists ### Create mailing list - [GET /Email/add_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/add_list.md): This function creates a Mailman mailing list. When you disable the role, the system this function. ### Add administrators to mailing list - [GET /Email/add_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/add_mailman_delegates.md): This function grants mailing list administrative privileges to users. When you disable the role, the system this function. ### Return cPanel account's mailing list total - [GET /Email/count_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/count_lists.md): This function returns the number of mailing lists for every email address on a cPanel account. When you disable the role, the system this function. ### Delete mailing list - [GET /Email/delete_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/delete_list.md): This function deletes a Mailman mailing list. When you disable the role, the system this function. ### Export cPanel account's Mailman mailing lists to a file - [GET /Email/export_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/export_lists.md): This function exports a cPanel account's Mailman mailing lists into a CSV file. This file is located in mail/exported_lists under the user's home directory. ### Create one-time password for a mailing list - [GET /Email/generate_mailman_otp](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/generate_mailman_otp.md): This function generates a one-time password (OTP) for a mailing list. The generated password expires after one use. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailing list disk usage - [GET /Email/get_lists_total_disk_usage](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/get_lists_total_disk_usage.md): This function returns the total disk usage for the mailing lists of a cPanel account. When you disable the Receive Mail role, the system this function. ### Return mailing list administrators - [GET /Email/get_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/get_mailman_delegates.md): This function lists a mailing list's administrators. When you disable the Receive Mail role, the system this function. ### Return email account's mailing list privileges - [GET /Email/has_delegated_mailman_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/has_delegated_mailman_lists.md): This function checks an account's administrative privileges on mailing lists. When you disable the Receive Mail role, the system this function. ### Return cPanel account's mailing lists - [GET /Email/list_lists](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/list_lists.md): This function lists the account's Mailman mailing lists. ### Update mailing list password - [GET /Email/passwd_list](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/passwd_list.md): This function changes a mailing list's password. When you disable the _Receive Mail_ role, the system this function. ### Remove account mailing list admin privileges - [GET /Email/remove_mailman_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/remove_mailman_delegates.md): This function removes an account's mailing list administrative privileges. ### Update mailing list privacy options - [GET /Email/set_list_privacy_options](https://api.docs.cpanel.net/specifications/cpanel.openapi/mailing-lists/set_list_privacy_options.md): This function modifies a Mailman mailing list's privacy options. When you disable the Receive Mail role, the system this function. ## GPG The GPG module for UAPI. ### Delete GnuPG key pair - [GET /GPG/delete_keypair](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/delete_keypair.md): This function deletes a GnuPG (GPG) key pair. ### Export GnuPG public key - [GET /GPG/export_public_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/export_public_key.md): This function exports a GnuPG (GPG) public key. ### Export GnuPG secret key - [GET /GPG/export_secret_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/export_secret_key.md): This function exports a GnuPG (GPG) secret key. ### Create GnuPG key - [GET /GPG/generate_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/generate_key.md): This function generates a GnuPG (GPG) key. The system saves the key in the user's directory. This function uses the system's entropy) to generate the key. Systems with low entropy levels may cause long generation times or timeouts. ### Import GnuPG key - [GET /GPG/import_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/import_key.md): This function imports a GnuPG (GPG) key. ### Return current user's GnuPG public keys - [GET /GPG/list_public_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/list_public_keys.md): This function lists the GnuPG (GPG) public keys for the currently-authenticated account. ### Return current user's GnuPG secret keys - [GET /GPG/list_secret_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/list_secret_keys.md): This function lists the GnuPG (GPG) secret keys for the currently-authenticated account. ## Signing and Encryption (GnuPG Keys) Email / Signing and Encryption (GnuPG Keys) ### Delete GnuPG key pair - [GET /GPG/delete_keypair](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/delete_keypair.md): This function deletes a GnuPG (GPG) key pair. ### Export GnuPG public key - [GET /GPG/export_public_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/export_public_key.md): This function exports a GnuPG (GPG) public key. ### Export GnuPG secret key - [GET /GPG/export_secret_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/export_secret_key.md): This function exports a GnuPG (GPG) secret key. ### Create GnuPG key - [GET /GPG/generate_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/generate_key.md): This function generates a GnuPG (GPG) key. The system saves the key in the user's directory. This function uses the system's entropy) to generate the key. Systems with low entropy levels may cause long generation times or timeouts. ### Import GnuPG key - [GET /GPG/import_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/import_key.md): This function imports a GnuPG (GPG) key. ### Return current user's GnuPG public keys - [GET /GPG/list_public_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/list_public_keys.md): This function lists the GnuPG (GPG) public keys for the currently-authenticated account. ### Return current user's GnuPG secret keys - [GET /GPG/list_secret_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/signing-and-encryption-(gnupg-keys)/list_secret_keys.md): This function lists the GnuPG (GPG) secret keys for the currently-authenticated account. ## cPGreyList The cPGreyList module for UAPI. ### Disable Greylisting for all domains - [GET /cPGreyList/disable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-disable_all_domains.md): This function disables Greylisting on a cPanel account's domains. ### Disable Greylisting for specified domains - [GET /cPGreyList/disable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-disable_domains.md): This function disables Greylisting on a cPanel account's selected domains. ### Enable Greylisting for all domains - [GET /cPGreyList/enable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-enable_all_domains.md): This function enables Greylisting on all of the cPanel account's domains. ### Enable Greylisting for specified domains - [GET /cPGreyList/enable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-enable_domains.md): This function enables Greylisting on a cPanel account's selected domains. ### Return whether Greylisting is enabled - [GET /cPGreyList/has_greylisting_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/has_greylisting_enabled.md): This function checks whether Greylisting is enabled for the cPanel account. ### Return Greylisting status for domains - [GET /cPGreyList/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist::list_domains.md): This function returns Greylisting's status for a cPanel account's domains. ## Spam Filtering (Greylisting) Email / Spam Filtering (Greylisting) ### Disable Greylisting for all domains - [GET /cPGreyList/disable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-disable_all_domains.md): This function disables Greylisting on a cPanel account's domains. ### Disable Greylisting for specified domains - [GET /cPGreyList/disable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-disable_domains.md): This function disables Greylisting on a cPanel account's selected domains. ### Enable Greylisting for all domains - [GET /cPGreyList/enable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-enable_all_domains.md): This function enables Greylisting on all of the cPanel account's domains. ### Enable Greylisting for specified domains - [GET /cPGreyList/enable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist-enable_domains.md): This function enables Greylisting on a cPanel account's selected domains. ### Return whether Greylisting is enabled - [GET /cPGreyList/has_greylisting_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/has_greylisting_enabled.md): This function checks whether Greylisting is enabled for the cPanel account. ### Return Greylisting status for domains - [GET /cPGreyList/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-filtering-(greylisting)/cpgreylist::list_domains.md): This function returns Greylisting's status for a cPanel account's domains. ## Spam Management Email / Spam Management ### Update minimum spam score threshold value - [GET /Email/add_spam_filter](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/add_spam_filter.md): This function sets a new minimum Apache SpamAssassin™ spam score threshold value. * To disable spam filtering, use the UAPI fuction. * For more information, read our Spam Filters documentation. Spam Filter* role, the system this function. ### Disable Apache SpamAssassin for cPanel account - [GET /Email/disable_spam_assassin](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_assassin.md): This function disables Apache SpamAssassin™ for a cPanel account. When you disable the role, the system this function. ### Disable spam box filtering auto-delete - [GET /Email/disable_spam_autodelete](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_autodelete.md): This function disables the Apache SpamAssassin™ auto-delete spam feature. When you disable the role, the system this function. ### Disable spam box filtering for cPanel account - [GET /Email/disable_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/disable_spam_box.md): This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account's inbox. * This function that your hosting provider enables Apache SpamAssassin™ on the server. * To spam box filtering, use the UAPI function. * For more information, read our Spam Filters documentation. When you disable the role, the system this function. ### Enable Apache SpamAssassin for cPanel account - [GET /Email/enable_spam_assassin](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/enable_spam_assassin.md): This function enables Apache SpamAssassin™ for the account. When you disable the Spam Filter role, the system this function. ### Enable spam box filtering for cPanel account - [GET /Email/enable_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/enable_spam_box.md): This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder. * This function that your hosting provider enables Apache SpamAssassin on the server. * To spam box filtering, use the UAPI function. * For more information, read our Spam Filters documentation. When you disable the Spam Filter role, the system this function. ### Return email account Apache SpamAssassin settings - [GET /Email/get_spam_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_spam_settings.md): This function retrieves the Apache SpamAssassin™ settings for the account. When you disable the SpamFilter role, the system this function. ### Delete spam box contents - [GET /SpamAssassin/clear_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/clear_spam_box.md): This function clears the spam box of all its contents for all email accounts. This function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account. ### Return SpamAssassin™ symbolic test scores - [GET /SpamAssassin/get_symbolic_test_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_symbolic_test_names.md): This function lists the Apache SpamAssassin™ scores for each symbolic test. ### Return SpamAssassin™ settings - [GET /SpamAssassin/get_user_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_user_preferences.md): This function lists the Apache SpamAssassin™ settings for the account. Additional customizations may appear in the returns. Form more information read the Apache SpamAssassin™ configuration file documentation. ### Update SpamAssassin™ settings - [GET /SpamAssassin/update_user_preference](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/update_user_preference.md): This function sets the Apache SpamAssassin™ settings for the account. Additional customizations may appear in the function's return. For more information, read the Apache SpamAssassin configuration file documentation. ## SpamAssassin The SpamAssassin module for UAPI. ### Delete spam box contents - [GET /SpamAssassin/clear_spam_box](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/clear_spam_box.md): This function clears the spam box of all its contents for all email accounts. This function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account. ### Return SpamAssassin™ symbolic test scores - [GET /SpamAssassin/get_symbolic_test_names](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_symbolic_test_names.md): This function lists the Apache SpamAssassin™ scores for each symbolic test. ### Return SpamAssassin™ settings - [GET /SpamAssassin/get_user_preferences](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/get_user_preferences.md): This function lists the Apache SpamAssassin™ settings for the account. Additional customizations may appear in the returns. Form more information read the Apache SpamAssassin™ configuration file documentation. ### Update SpamAssassin™ settings - [GET /SpamAssassin/update_user_preference](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-management/update_user_preference.md): This function sets the Apache SpamAssassin™ settings for the account. Additional customizations may appear in the function's return. For more information, read the Apache SpamAssassin configuration file documentation. ## BoxTrapper The BoxTrapper module for UAPI. ### Add email address to BoxTrapper blocked senders - [GET /BoxTrapper/blacklist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/blacklist_messages.md): This function blacklists email message senders. When you disable the Receive Mail role, the system disables this function. ### Delete messages in the BoxTrapper queue - [GET /BoxTrapper/delete_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/delete_messages.md): This function deletes messages in the BoxTrapper queue. When you disable the Receive Mail role, the system disables this function. ### Send messages in the BoxTrapper queue - [GET /BoxTrapper/deliver_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/deliver_messages.md): This function delivers messages in the BoxTrapper queue. When you disable the role, the system this function. ### Return account BoxTrapper allowlist rules - [GET /BoxTrapper/get_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_allowlist.md): This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules. When you disable the role, the system this function. ### Return account BoxTrapper blocklist rules - [GET /BoxTrapper/get_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_blocklist.md): This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender. When you disable the role, the system this function. ### Return email account's BoxTrapper configuration - [GET /BoxTrapper/get_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_configuration.md): This function retrieves an account's BoxTrapper configuration. When you disable the Receive Mail role, the system disables this function. ### Return specified BoxTrapper email template - [GET /BoxTrapper/get_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_email_template.md): This function retrieves a BoxTrapper email message template. When you disable the role, the system this function. ### Return all BoxTrapper forwarders - [GET /BoxTrapper/get_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_forwarders.md): This function retrieves a list of email addresses to which BoxTrapper forwards email messages. When you disable the Receive Mail role, the system this function. ### Return account BoxTrapper ignorelist rules - [GET /BoxTrapper/get_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_ignorelist.md): This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender. When you disable the role, the system this function. ### Return BoxTrapper log file and contents - [GET /BoxTrapper/get_log](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_log.md): This function returns the account's BoxTrapper log file and its contents. When you disable the Receive Mail role, the system this function. ### Return message's top 200 lines in BoxTrapper queue - [GET /BoxTrapper/get_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_message.md): This function returns the first 200 lines of an email in the BoxTrapper queue. When you disable the Receive Mail role, the system this function. ### Return whether email account uses BoxTrapper - [GET /BoxTrapper/get_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_status.md): This function checks whether BoxTrapper is enabled for an email account. When you disable the Receive Mail role, the system this function. ### Add email account to Exim ignore list - [GET /BoxTrapper/ignore_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/ignore_messages.md): This function marks email message senders for Exim to ignore. When you disable the Receive Mail role, the system this function. ### Return BoxTrapper email templates - [GET /BoxTrapper/list_email_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_email_templates.md): This function lists the BoxTrapper email templates. When you the Receive Mail role, the system disables this function. ### Return email account's BoxTrapper queued messages - [GET /BoxTrapper/list_queued_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_queued_messages.md): This function returns a list of messages in the account's BoxTrapper queue. When you disable the role, the system this function. ### Run a specific BoxTrapper action for a message - [GET /BoxTrapper/process_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/process_messages.md): This function performs a specified action on messages in the BoxTrapper queue. When you disable the role, the system this function. ### Restore default BoxTrapper email message template - [GET /BoxTrapper/reset_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/reset_email_template.md): This function restores the BoxTrapper email message templates to the system default setting. When you the Receive Mail role, the system disables this function. ### Update email account's BoxTrapper configuration - [GET /BoxTrapper/save_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_configuration.md): This function modifies an account's BoxTrapper configuration. When you disable the Receive Mail role, the system this function. ### Save BoxTrapper message template contents - [GET /BoxTrapper/save_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_email_template.md): This function saves the contents of a BoxTrapper message template. When you disable the _Receive Mail_ role, the system this function. ### Update account BoxTrapper allowlist - [GET /BoxTrapper/set_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_allowlist.md): This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules. When you disable the role, the system this function. ### Update account BoxTrapper blocklist - [GET /BoxTrapper/set_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_blocklist.md): This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender. When you disable the role, the system this function. ### Add email address to BoxTrapper forwarders - [GET /BoxTrapper/set_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_forwarders.md): This function adds a list of email addresses to which BoxTrapper forwards email messages. When you disable the Receive Mail role, the system this function. ### Update account BoxTrapper ignorelist - [GET /BoxTrapper/set_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_ignorelist.md): This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender. When you disable the role, the system this function. ### Enable or disable BoxTrapper for email account - [GET /BoxTrapper/set_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_status.md): This function enables or disables BoxTrapper for an email account. When you disable the Receive Mail role, the system this function. ### Add email address to BoxTrapper allowed senders - [GET /BoxTrapper/whitelist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/whitelist_messages.md): This function whitelists email messages. When you disable the Receive Mail role, the system this function. To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI function. ## Spam Prevention (BoxTrapper) Email / Spam Prevention (BoxTrapper) ### Add email address to BoxTrapper blocked senders - [GET /BoxTrapper/blacklist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/blacklist_messages.md): This function blacklists email message senders. When you disable the Receive Mail role, the system disables this function. ### Delete messages in the BoxTrapper queue - [GET /BoxTrapper/delete_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/delete_messages.md): This function deletes messages in the BoxTrapper queue. When you disable the Receive Mail role, the system disables this function. ### Send messages in the BoxTrapper queue - [GET /BoxTrapper/deliver_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/deliver_messages.md): This function delivers messages in the BoxTrapper queue. When you disable the role, the system this function. ### Return account BoxTrapper allowlist rules - [GET /BoxTrapper/get_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_allowlist.md): This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules. When you disable the role, the system this function. ### Return account BoxTrapper blocklist rules - [GET /BoxTrapper/get_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_blocklist.md): This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender. When you disable the role, the system this function. ### Return email account's BoxTrapper configuration - [GET /BoxTrapper/get_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_configuration.md): This function retrieves an account's BoxTrapper configuration. When you disable the Receive Mail role, the system disables this function. ### Return specified BoxTrapper email template - [GET /BoxTrapper/get_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_email_template.md): This function retrieves a BoxTrapper email message template. When you disable the role, the system this function. ### Return all BoxTrapper forwarders - [GET /BoxTrapper/get_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_forwarders.md): This function retrieves a list of email addresses to which BoxTrapper forwards email messages. When you disable the Receive Mail role, the system this function. ### Return account BoxTrapper ignorelist rules - [GET /BoxTrapper/get_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::get_ignorelist.md): This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender. When you disable the role, the system this function. ### Return BoxTrapper log file and contents - [GET /BoxTrapper/get_log](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_log.md): This function returns the account's BoxTrapper log file and its contents. When you disable the Receive Mail role, the system this function. ### Return message's top 200 lines in BoxTrapper queue - [GET /BoxTrapper/get_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_message.md): This function returns the first 200 lines of an email in the BoxTrapper queue. When you disable the Receive Mail role, the system this function. ### Return whether email account uses BoxTrapper - [GET /BoxTrapper/get_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/get_status.md): This function checks whether BoxTrapper is enabled for an email account. When you disable the Receive Mail role, the system this function. ### Add email account to Exim ignore list - [GET /BoxTrapper/ignore_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/ignore_messages.md): This function marks email message senders for Exim to ignore. When you disable the Receive Mail role, the system this function. ### Return BoxTrapper email templates - [GET /BoxTrapper/list_email_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_email_templates.md): This function lists the BoxTrapper email templates. When you the Receive Mail role, the system disables this function. ### Return email account's BoxTrapper queued messages - [GET /BoxTrapper/list_queued_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/list_queued_messages.md): This function returns a list of messages in the account's BoxTrapper queue. When you disable the role, the system this function. ### Run a specific BoxTrapper action for a message - [GET /BoxTrapper/process_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/process_messages.md): This function performs a specified action on messages in the BoxTrapper queue. When you disable the role, the system this function. ### Restore default BoxTrapper email message template - [GET /BoxTrapper/reset_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/reset_email_template.md): This function restores the BoxTrapper email message templates to the system default setting. When you the Receive Mail role, the system disables this function. ### Update email account's BoxTrapper configuration - [GET /BoxTrapper/save_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_configuration.md): This function modifies an account's BoxTrapper configuration. When you disable the Receive Mail role, the system this function. ### Save BoxTrapper message template contents - [GET /BoxTrapper/save_email_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/save_email_template.md): This function saves the contents of a BoxTrapper message template. When you disable the _Receive Mail_ role, the system this function. ### Update account BoxTrapper allowlist - [GET /BoxTrapper/set_allowlist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_allowlist.md): This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules. When you disable the role, the system this function. ### Update account BoxTrapper blocklist - [GET /BoxTrapper/set_blocklist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_blocklist.md): This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender. When you disable the role, the system this function. ### Add email address to BoxTrapper forwarders - [GET /BoxTrapper/set_forwarders](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_forwarders.md): This function adds a list of email addresses to which BoxTrapper forwards email messages. When you disable the Receive Mail role, the system this function. ### Update account BoxTrapper ignorelist - [GET /BoxTrapper/set_ignorelist](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/boxtrapper::set_ignorelist.md): This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender. When you disable the role, the system this function. ### Enable or disable BoxTrapper for email account - [GET /BoxTrapper/set_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/set_status.md): This function enables or disables BoxTrapper for an email account. When you disable the Receive Mail role, the system this function. ### Add email address to BoxTrapper allowed senders - [GET /BoxTrapper/whitelist_messages](https://api.docs.cpanel.net/specifications/cpanel.openapi/spam-prevention-(boxtrapper)/whitelist_messages.md): This function whitelists email messages. When you disable the Receive Mail role, the system this function. To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI function. ## WebmailApps The WebmailApps module for UAPI. ### Return available webmail clients - [GET /WebmailApps/list_webmail_apps](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-applications/list_webmail_apps.md): This function lists the account's available webmail clients. When you disable the Receive Mail role, the system this function. ## Webmail Applications Email / Webmail Applications ### Return available webmail clients - [GET /WebmailApps/list_webmail_apps](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-applications/list_webmail_apps.md): This function lists the account's available webmail clients. When you disable the Receive Mail role, the system this function. ## Session The Session module for UAPI. ### Create user session with existing session - [GET /Session/create_temp_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_temp_user.md): This function creates a temporary user session. * Because this function requires a valid cPanel session ID, you call it via a cPanel or Webmail session URL. If you call this function via the command line or Template Toolkit, it will create a temporary user session. You use the WHM API 1 function to create a temporary user session. * Third-party plugins that require access to temporary MySQL users call this function via the URL. It will create the temporary users before they are available. You can find these users in the environment variable. * If you update your system, update your scripts to call the function. This will create a temporary user session for you. ### Create Webmail session - [GET /Session/create_webmail_session_for_mail_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_mail_user.md): Create a temporary session for a cPanel user to connect to Webmail. The cPanel user must own the Webmail account. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ### Create Webmail session with credentials - [GET /Session/create_webmail_session_for_mail_user_check_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_mail_user_check_password.md): This function creates a temporary session with a password for the calling cPanel user to connect to Webmail. * The cPanel user must own the Webmail account. * This function works like the UAPI Session::create_webmail_session_for_mail_user function with one exception. This function requires a correct password to create the Webmail session. If you use an incorrect password or attempt to connect to a suspended account, the login will fail. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ### Create Webmail session for current user - [GET /Session/create_webmail_session_for_self](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_self.md): Create a temporary session to connect to Webmail for the authenticated cPanel user. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ## Webmail Sessions Email / Webmail Sessions ### Create user session with existing session - [GET /Session/create_temp_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_temp_user.md): This function creates a temporary user session. * Because this function requires a valid cPanel session ID, you call it via a cPanel or Webmail session URL. If you call this function via the command line or Template Toolkit, it will create a temporary user session. You use the WHM API 1 function to create a temporary user session. * Third-party plugins that require access to temporary MySQL users call this function via the URL. It will create the temporary users before they are available. You can find these users in the environment variable. * If you update your system, update your scripts to call the function. This will create a temporary user session for you. ### Create Webmail session - [GET /Session/create_webmail_session_for_mail_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_mail_user.md): Create a temporary session for a cPanel user to connect to Webmail. The cPanel user must own the Webmail account. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ### Create Webmail session with credentials - [GET /Session/create_webmail_session_for_mail_user_check_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_mail_user_check_password.md): This function creates a temporary session with a password for the calling cPanel user to connect to Webmail. * The cPanel user must own the Webmail account. * This function works like the UAPI Session::create_webmail_session_for_mail_user function with one exception. This function requires a correct password to create the Webmail session. If you use an incorrect password or attempt to connect to a suspended account, the login will fail. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ### Create Webmail session for current user - [GET /Session/create_webmail_session_for_self](https://api.docs.cpanel.net/specifications/cpanel.openapi/webmail-sessions/create_webmail_session_for_self.md): Create a temporary session to connect to Webmail for the authenticated cPanel user. ### How to use this API After you successfully call this API, you will need to log in to Webmail. To do this, send an HTTP POST to with a message body of where: * represents the value from the return. * If the return value is , enter the hostname of the server that answered the API function. * represents the value from the token return. * represents the value of the session return. For example, an HTTP POST may resemble the following: With a message body of: ## Ftp The Ftp module for UAPI. ### Create FTP account - [GET /Ftp/add_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/add_ftp.md): This function creates an FTP account. When you disable the FTP role, the system this function. ### Delete FTP account - [GET /Ftp/delete_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/delete_ftp.md): This function deletes an FTP account. When you disable the role, the system this function. ### Return whether an FTP account exists - [GET /Ftp/ftp_exists](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/ftp_exists.md): This function checks whether an FTP account exists. This function returns only metadata if the FTP account exists, or an error if the FTP account does exist. ### Return FTP account's quota - [GET /Ftp/get_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/get_quota.md): This function checks an FTP account's quota. When you disable the _FTP role_, the system this function. ### Return FTP account's welcome message - [GET /Ftp/get_welcome_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/get_welcome_message.md): This function retrieves the cPanel account's FTP welcome message. When you disable the role, the system this function. ### Return FTP accounts - [GET /Ftp/list_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/list_ftp.md): This function lists FTP account information. When you disable the role, the system this function. For more information, read our How to Use Server Profiles documentation. ### Return FTP accounts and disk usage - [GET /Ftp/list_ftp_with_disk](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/list_ftp_with_disk.md): This function lists FTP account and disk usage information. When you disable the FTP role, the system this function. ### Update FTP account's password - [GET /Ftp/passwd](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/passwd.md): This function changes an FTP account's password. When you disable the FTP role, the system this function. ### Update FTP account's home directory - [GET /Ftp/set_homedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_homedir.md): This function changes the home directory for FTP accounts. When you disable the FTP role, the system this function. ### Update FTP account's quota - [GET /Ftp/set_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_quota.md): This function changes an FTP account's quota. When you disable the FTP role, the system this function. ### Update FTP welcome message - [GET /Ftp/set_welcome_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_welcome_message.md): This function sets the FTP welcome message. When you disable the FTP role, the system this function. ### Return if anonymous FTP connections allowed - [GET /Ftp/allows_anonymous_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/allows_anonymous_ftp.md): This function checks whether the account allows anonymous FTP connections. When you disable the role, the system this function. ### Return if anonymous FTP transfers allowed - [GET /Ftp/allows_anonymous_ftp_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/allows_anonymous_ftp_incoming.md): This function checks whether the account allows inbound anonymous FTP transfers. When you disable the role, the system this function. ### Return FTP server's information - [GET /Ftp/get_ftp_daemon_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/get_ftp_daemon_info.md): This function retrieves the extended information about the server's FTP daemon. ### Return FTP server's port - [GET /Ftp/get_port](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/get_port.md): This function returns the FTP port. When you disable the role, the system this function. ### Stop FTP session - [GET /Ftp/kill_session](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/kill_session.md): This function kills FTP sessions. When you disable the Role, the system this function. ### Return FTP server's active sessions - [GET /Ftp/list_sessions](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/list_sessions.md): This function lists the FTP server's active sessions. When you disable the FTP role, the system this function. ### Return whether server uses ProFTPD or Pure-FTPd - [GET /Ftp/server_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/server_name.md): This function checks whether the server uses ProFTPD or Pure-FTPd. When you disable the FTP role, the system this function. ### Enable or disable anonymous FTP logins - [GET /Ftp/set_anonymous_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/set_anonymous_ftp.md): This function enables or disables anonymous FTP logins. When you disable the FTP role, the system this function. ### Enable or disable anonymous incoming FTP transfers - [GET /Ftp/set_anonymous_ftp_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/set_anonymous_ftp_incoming.md): This function enables or disables inbound anonymous FTP transfers. When you disable the FTP role, the system this function. ## FTP Accounts Files / FTP Accounts ### Create FTP account - [GET /Ftp/add_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/add_ftp.md): This function creates an FTP account. When you disable the FTP role, the system this function. ### Delete FTP account - [GET /Ftp/delete_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/delete_ftp.md): This function deletes an FTP account. When you disable the role, the system this function. ### Return whether an FTP account exists - [GET /Ftp/ftp_exists](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/ftp_exists.md): This function checks whether an FTP account exists. This function returns only metadata if the FTP account exists, or an error if the FTP account does exist. ### Return FTP account's quota - [GET /Ftp/get_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/get_quota.md): This function checks an FTP account's quota. When you disable the _FTP role_, the system this function. ### Return FTP account's welcome message - [GET /Ftp/get_welcome_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/get_welcome_message.md): This function retrieves the cPanel account's FTP welcome message. When you disable the role, the system this function. ### Return FTP accounts - [GET /Ftp/list_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/list_ftp.md): This function lists FTP account information. When you disable the role, the system this function. For more information, read our How to Use Server Profiles documentation. ### Return FTP accounts and disk usage - [GET /Ftp/list_ftp_with_disk](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/list_ftp_with_disk.md): This function lists FTP account and disk usage information. When you disable the FTP role, the system this function. ### Update FTP account's password - [GET /Ftp/passwd](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/passwd.md): This function changes an FTP account's password. When you disable the FTP role, the system this function. ### Update FTP account's home directory - [GET /Ftp/set_homedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_homedir.md): This function changes the home directory for FTP accounts. When you disable the FTP role, the system this function. ### Update FTP account's quota - [GET /Ftp/set_quota](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_quota.md): This function changes an FTP account's quota. When you disable the FTP role, the system this function. ### Update FTP welcome message - [GET /Ftp/set_welcome_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-accounts/set_welcome_message.md): This function sets the FTP welcome message. When you disable the FTP role, the system this function. ## FTP Server Settings Files / FTP Server Settings ### Return if anonymous FTP connections allowed - [GET /Ftp/allows_anonymous_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/allows_anonymous_ftp.md): This function checks whether the account allows anonymous FTP connections. When you disable the role, the system this function. ### Return if anonymous FTP transfers allowed - [GET /Ftp/allows_anonymous_ftp_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/allows_anonymous_ftp_incoming.md): This function checks whether the account allows inbound anonymous FTP transfers. When you disable the role, the system this function. ### Return FTP server's information - [GET /Ftp/get_ftp_daemon_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/get_ftp_daemon_info.md): This function retrieves the extended information about the server's FTP daemon. ### Return FTP server's port - [GET /Ftp/get_port](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/get_port.md): This function returns the FTP port. When you disable the role, the system this function. ### Stop FTP session - [GET /Ftp/kill_session](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/kill_session.md): This function kills FTP sessions. When you disable the Role, the system this function. ### Return FTP server's active sessions - [GET /Ftp/list_sessions](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/list_sessions.md): This function lists the FTP server's active sessions. When you disable the FTP role, the system this function. ### Return whether server uses ProFTPD or Pure-FTPd - [GET /Ftp/server_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/server_name.md): This function checks whether the server uses ProFTPD or Pure-FTPd. When you disable the FTP role, the system this function. ### Enable or disable anonymous FTP logins - [GET /Ftp/set_anonymous_ftp](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/set_anonymous_ftp.md): This function enables or disables anonymous FTP logins. When you disable the FTP role, the system this function. ### Enable or disable anonymous incoming FTP transfers - [GET /Ftp/set_anonymous_ftp_incoming](https://api.docs.cpanel.net/specifications/cpanel.openapi/ftp-server-settings/set_anonymous_ftp_incoming.md): This function enables or disables inbound anonymous FTP transfers. When you disable the FTP role, the system this function. ## ImageManager The ImageManager module for UAPI. ### Create image with new format - [GET /ImageManager/convert_file](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/convert_file.md): This function converts an image to a new file format. When you disable the WebServer role, the system this function. ### Create image thumbnails - [GET /ImageManager/create_thumbnails](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/create_thumbnails.md): This function creates thumbnails from images. The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with ``). When you disable the WebServer role, the system disables this function. ### Return image dimensions - [GET /ImageManager/get_dimensions](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/get_dimensions.md): This function returns the dimensions of the image file that you specify. When you disable the WebServer role, the system this function. ### Save resized image - [GET /ImageManager/resize_image](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/resize_image.md): This function resizes a specified image. When you disable the WebServer role, the system this function. ## Image Tools Files / Image Tools ### Create image with new format - [GET /ImageManager/convert_file](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/convert_file.md): This function converts an image to a new file format. When you disable the WebServer role, the system this function. ### Create image thumbnails - [GET /ImageManager/create_thumbnails](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/create_thumbnails.md): This function creates thumbnails from images. The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with ``). When you disable the WebServer role, the system disables this function. ### Return image dimensions - [GET /ImageManager/get_dimensions](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/get_dimensions.md): This function returns the dimensions of the image file that you specify. When you disable the WebServer role, the system this function. ### Save resized image - [GET /ImageManager/resize_image](https://api.docs.cpanel.net/specifications/cpanel.openapi/image-tools/resize_image.md): This function resizes a specified image. When you disable the WebServer role, the system this function. ## Fileman The Fileman module for UAPI. ### Return autocomplete file and directory names - [GET /Fileman/autocompletedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/autocompletedir.md): This function returns any files and directories that begin with a specified string. When you disable the File Storage role, the system this function. ### Delete .trash folder content - [GET /Fileman/empty_trash](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/empty_trash.md): This function purges content from the folder in the user's home directory. When you disable the FileStorage role, the system this function. ### Return file content - [GET /Fileman/get_file_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/get_file_content.md): This function retrieves a file's content. When you disable the File Storage role, the system this function. JSON strings be valid UTF-8. To retrieve a non-UTF-8 file via JSON, we recommend that you give as and as , then decode the return payload’s as UTF-8. ### Return file or directory information - [GET /Fileman/get_file_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/get_file_information.md): This function returns the information for a specified file or directory. When you disable the File Storage role, the system this function. ### Return directory content - [GET /Fileman/list_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/list_files.md): This function returns a sorted list of files and directories. When you disable the FileStorage role, the system this function. For more information, read our How to Use Server Profiles documentation. ### Save file - [GET /Fileman/save_file_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/save_file_content.md): This function saves a file in a directory and encodes it in a character set. When you disable the File Storage role, the system this function. ### Update buffer encoding - [GET /Fileman/transcode](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/transcode.md): This function converts a buffer from one encoding language to another. When you disable the File Storage role, the system this function. ### Upload files - [GET /Fileman/upload_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/upload_files.md): This function uploads files. For more information about how to use this function in your custom code, read our [Use UAPI's Function in Custom Code tutorial](https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-code). When you disable the File Storage role, the system this function. You cannot call this function through WHM API 1's uapi_cpanel function. ## Manage Files Files / Manage Files ### Return autocomplete file and directory names - [GET /Fileman/autocompletedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/autocompletedir.md): This function returns any files and directories that begin with a specified string. When you disable the File Storage role, the system this function. ### Delete .trash folder content - [GET /Fileman/empty_trash](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/empty_trash.md): This function purges content from the folder in the user's home directory. When you disable the FileStorage role, the system this function. ### Return file content - [GET /Fileman/get_file_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/get_file_content.md): This function retrieves a file's content. When you disable the File Storage role, the system this function. JSON strings be valid UTF-8. To retrieve a non-UTF-8 file via JSON, we recommend that you give as and as , then decode the return payload’s as UTF-8. ### Return file or directory information - [GET /Fileman/get_file_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/get_file_information.md): This function returns the information for a specified file or directory. When you disable the File Storage role, the system this function. ### Return directory content - [GET /Fileman/list_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/list_files.md): This function returns a sorted list of files and directories. When you disable the FileStorage role, the system this function. For more information, read our How to Use Server Profiles documentation. ### Save file - [GET /Fileman/save_file_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/save_file_content.md): This function saves a file in a directory and encodes it in a character set. When you disable the File Storage role, the system this function. ### Update buffer encoding - [GET /Fileman/transcode](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/transcode.md): This function converts a buffer from one encoding language to another. When you disable the File Storage role, the system this function. ### Upload files - [GET /Fileman/upload_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/manage-files/upload_files.md): This function uploads files. For more information about how to use this function in your custom code, read our [Use UAPI's Function in Custom Code tutorial](https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-code). When you disable the File Storage role, the system this function. You cannot call this function through WHM API 1's uapi_cpanel function. ## WebDisk The WebDisk module for UAPI. ### Delete Web Disk account - [GET /WebDisk/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::delete_user.md): This function deletes a Web Disk account. When you disable the Web Disk role, the system this function. ### Update Web Disk home directory location - [GET /WebDisk/set_homedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::set_homedir.md): This function changes the home directory for a Web Disk account. When you disable the Web Disk role, the system this function. ### Update Web Disk account password - [GET /WebDisk/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::set_password.md): This function changes the Web Disk account's password. When you disable the Web Disk role, the system this function. ### Update Web Disk home directory permissions - [GET /WebDisk/set_permissions](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/set_permissions.md): This function changes the Web Disk home directory's permissions. When you disable the Web Disk role, the system this function. ## WebDisk Settings Files / WebDisk Settings ### Delete Web Disk account - [GET /WebDisk/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::delete_user.md): This function deletes a Web Disk account. When you disable the Web Disk role, the system this function. ### Update Web Disk home directory location - [GET /WebDisk/set_homedir](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::set_homedir.md): This function changes the home directory for a Web Disk account. When you disable the Web Disk role, the system this function. ### Update Web Disk account password - [GET /WebDisk/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/webdisk::set_password.md): This function changes the Web Disk account's password. When you disable the Web Disk role, the system this function. ### Update Web Disk home directory permissions - [GET /WebDisk/set_permissions](https://api.docs.cpanel.net/specifications/cpanel.openapi/webdisk-settings/set_permissions.md): This function changes the Web Disk home directory's permissions. When you disable the Web Disk role, the system this function. ## VersionControlDeployment The VersionControlDeployment module for UAPI. ### Create Git deployment task - [GET /VersionControlDeployment/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment::create.md): This function deploys the changes from a cPanel-managed repository. The system logs messages for this function in the file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the option and will only succeed if the branch's HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our Guide to Git™ - Deployment documentation. Before deployment, repositories must meet the following requirements: * A valid checked-in file in the top-level directory. * One or more local or remote branches. * A clean working tree. If a repository does meet these requirements, the system will display deployment information. Also, it will disable deployment functionality. For more information, read our Guide to Git™ - Deployment documentation. ### Delete Git deployment task - [GET /VersionControlDeployment/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/delete.md): This function deletes a deployment task. For more information, read our Guide to Git - Deployment documentation. ### Return Git deployment task status - [GET /VersionControlDeployment/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment::retrieve.md): This function retrieves the status of deployment tasks. Before deployment, repositories must meet the following requirements: * A valid checked-in file in the top-level directory. * One or more local or remote branches. * A clean working tree. If a repository does meet these requirements, the system will display deployment information. Also, it will disable deployment functionality. For more information, read our Guide to Git™ - Deployment documentation. The system logs messages for this function in the file, where represents the time in Unix epoch time. ## Deployment Settings GIT Management / Deployment Settings ### Create Git deployment task - [GET /VersionControlDeployment/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment::create.md): This function deploys the changes from a cPanel-managed repository. The system logs messages for this function in the file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the option and will only succeed if the branch's HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our Guide to Git™ - Deployment documentation. Before deployment, repositories must meet the following requirements: * A valid checked-in file in the top-level directory. * One or more local or remote branches. * A clean working tree. If a repository does meet these requirements, the system will display deployment information. Also, it will disable deployment functionality. For more information, read our Guide to Git™ - Deployment documentation. ### Delete Git deployment task - [GET /VersionControlDeployment/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/delete.md): This function deletes a deployment task. For more information, read our Guide to Git - Deployment documentation. ### Return Git deployment task status - [GET /VersionControlDeployment/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment::retrieve.md): This function retrieves the status of deployment tasks. Before deployment, repositories must meet the following requirements: * A valid checked-in file in the top-level directory. * One or more local or remote branches. * A clean working tree. If a repository does meet these requirements, the system will display deployment information. Also, it will disable deployment functionality. For more information, read our Guide to Git™ - Deployment documentation. The system logs messages for this function in the file, where represents the time in Unix epoch time. ## VersionControl The VersionControl module for UAPI. ### Create Git repository - [GET /VersionControl/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::create.md): This function creates a new Git™ repository on a cPanel account. * For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * For a list of configuration changes, repository restrictions, and troubleshooting steps, read our Guide to Git - For System Administrators documentation. The system logs errors for this function in the file, where represents the time of the error in Unix epoch time. ### Delete Git repository - [GET /VersionControl/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::delete.md): This function deletes a cPanel account's Git™ repository. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * When you call this function, the system the entire contents of the specified directory. You recover this data after deletion. * You use this function to delete any repositories that do not appear in the cache of repositories (for example, repositories that contain invalid characters or exist within cPanel-controlled directories). ### Return Git repositories - [GET /VersionControl/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::retrieve.md): This function lists Git™ repositories on a cPanel account. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * This feature does allow the following characters in repository paths: ` $ { } [ ] ( ) ; ? : = % #`.cpanel.htpasswds.ssh.trashaccess-logscgi-binetclogsperl5mailspamassassinssltmpvar` Users can create repositories in some of these directories on the command line. They may appear in the list of repositories in Gitweb, but users may see an error message if they try to access them. ### Update Git repository settings - [GET /VersionControl/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::update.md): This function modifies a Git™ repository's basic settings. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * This function pulls changes from the remote repository if you specify a value. * You modify the , , or values for existing repositories. * You include the parameter in order to identify the repository to update. * All other input parameters are . Use them to assign the values to the account. If you do not include a parameter or specify its existing value, no change will occur. ## Repository Management GIT Management / Repository Management ### Create Git repository - [GET /VersionControl/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::create.md): This function creates a new Git™ repository on a cPanel account. * For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * For a list of configuration changes, repository restrictions, and troubleshooting steps, read our Guide to Git - For System Administrators documentation. The system logs errors for this function in the file, where represents the time of the error in Unix epoch time. ### Delete Git repository - [GET /VersionControl/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::delete.md): This function deletes a cPanel account's Git™ repository. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * When you call this function, the system the entire contents of the specified directory. You recover this data after deletion. * You use this function to delete any repositories that do not appear in the cache of repositories (for example, repositories that contain invalid characters or exist within cPanel-controlled directories). ### Return Git repositories - [GET /VersionControl/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::retrieve.md): This function lists Git™ repositories on a cPanel account. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * This feature does allow the following characters in repository paths: ` $ { } [ ] ( ) ; ? : = % #`.cpanel.htpasswds.ssh.trashaccess-logscgi-binetclogsperl5mailspamassassinssltmpvar` Users can create repositories in some of these directories on the command line. They may appear in the list of repositories in Gitweb, but users may see an error message if they try to access them. ### Update Git repository settings - [GET /VersionControl/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/repository-management/versioncontrol::update.md): This function modifies a Git™ repository's basic settings. For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. * This function pulls changes from the remote repository if you specify a value. * You modify the , , or values for existing repositories. * You include the parameter in order to identify the repository to update. * All other input parameters are . Use them to assign the values to the account. If you do not include a parameter or specify its existing value, no change will occur. ## InProductSurvey The InProductSurvey module for cPanel UAPI. ### Return in-product survey banner data - [GET /InProductSurvey/get_in_product_survey_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/inproductsurvey/get_in_product_survey_url.md): This function returns whether the in-product survey banner should display for the current user and the survey link. * The function selects a link template based on whether the authenticated user is a webmail user or a cPanel/Team user. * A value of means you should not render the banner UI. ## Mysql The Mysql module for UAPI. ### Return MySQL server host information and version - [GET /Mysql/get_server_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-information/get_server_information.md): This function returns information about the account's MySQL® host. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Return MySQL server host information - [GET /Mysql/locate_server](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-information/locate_server.md): This function returns information about the account's MySQL® host. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Validate MySQL database integrity - [GET /Mysql/check_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-check_database.md): This function checks for errors in all of the tables in a MySQL® database. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Create MySQL database - [GET /Mysql/create_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/create_database.md): This function creates a MySQL® database. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Delete MySQL database - [GET /Mysql/delete_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/delete_database.md): This function deletes a MySQL® database. when you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Return MySQL database schema - [GET /Mysql/dump_database_schema](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/dump_database_schema.md): This function returns a string that you can give to MySQL® to recreate a particular database’s schema. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Return MySQL databases - [GET /Mysql/list_databases](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/list_databases.md): This function lists an account's MySQL® databases. When you disable the role remote MySQL is configured, the system this function. ### Update MySQL database name - [GET /Mysql/rename_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-rename_database.md): This function renames a MySQL® database. MySQL does not allow you to rename a database. When cPanel & WHM "renames" a database, the system performs the following steps: 1. The system creates a new database. 2. The system moves data from the old database to the new database. 3. The system recreates grants and stored code in the new database. 4. The system deletes the old database and its grants. * It is potentially dangerous to rename a MySQL database. We recommend that you perform a backup of the database before you attempt to rename it. * If any of the first three steps fail, the system returns an error and attempts to restore the database's original state. If the restoration process fails, the API function's error response describes these additional failures. * In rare cases, the system creates the second database successfully, but fails to delete the old database or grants. The system treats the rename action as a success; however, the API function returns warnings that describe the failure to delete the old database or grants. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Repair MySQL database tables - [GET /Mysql/repair_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/repair_database.md): This function repairs all of the tables in a MySQL® database. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Create a randomly named MySQL username/database set. - [GET /Mysql/setup_db_and_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/setup_db_and_user.md): This function creates a randomly named MySQL® database and user. This allows a 3rdparty tool to create its own DB without needing any knowledge of cPanel internals such as quotas or other limits. These will simply be passed back as an error. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Update MySQL® privileges - [GET /Mysql/update_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-update_privileges.md): This function updates privileges for all MySQL® databases and users on an account. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Enable remote MySQL host access - [GET /Mysql/add_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/add_host.md): This function authorizes a remote MySQL® host to access the account's databases. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Add remote MySQL host note - [GET /Mysql/add_host_note](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/mysql-add_host_note.md): This function adds a note about a remote MySQL® server. * If you attempt to add a note to an unauthorized remote MySQL server, the function will fail. * When you the MySQL role, the system disables this function. ### Disable remote MySQL host access - [GET /Mysql/delete_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/delete_host.md): This function removes a remote MySQL® host's access to the account's databases. When you disable the MySQL role and remote MySQL is not already configured, the system this function. ### Return remote MySQL host notes - [GET /Mysql/get_host_notes](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/get_host_notes.md): This function returns the notes associated with the account's remote MySQL® hosts. When you disable the role remote MySQL is already configured, the system this function. ### Create MySQL user - [GET /Mysql/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-create_user.md): This function creates a MySQL® database user. When you the MySQL role and remote MySQL is not already configured, the system disables this function. ### Delete MySQL user - [GET /Mysql/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql::delete_user.md): This function deletes a MySQL® user. When you disable the MySQL role and remote MySQL is not already configured, the system this function. ### Return MySQL user privileges - [GET /Mysql/get_privileges_on_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-get_privileges_on_database.md): This function lists a MySQL® database user's privileges. When you disable the MySQL role and remote MySQL is not already configured, the system disables this function. ### Return MySQL name length restrictions - [GET /Mysql/get_restrictions](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/get_restrictions.md): This function lists a MySQL® database's name, username length restrictions, and database prefix. When you disable the role remote MySQL is already configured, the system this function. ### Return MySQL user routines - [GET /Mysql/list_routines](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/list_routines.md): This function returns a database user's MySQL® routines. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Return MySQL users - [GET /Mysql/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-list_users.md): This function lists an account's MySQL® database users. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Update MySQL username - [GET /Mysql/rename_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/rename_user.md): This function renames a MySQL® database user. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Remove MySQL user privileges - [GET /Mysql/revoke_access_to_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/revoke_access_to_database.md): This function revokes a MySQL® database user's privileges. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Update MySQL user password - [GET /Mysql/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-set_password.md): This function sets a MySQL® database user's password. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Update MySQL user privileges - [GET /Mysql/set_privileges_on_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/set_privileges_on_database.md): This function sets a MySQL® database user's privileges. When you disable the role, remote MySQL is already configured, the system this function. ## Database Information MySQL and MariaDB / Database Information ### Return MySQL server host information and version - [GET /Mysql/get_server_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-information/get_server_information.md): This function returns information about the account's MySQL® host. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Return MySQL server host information - [GET /Mysql/locate_server](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-information/locate_server.md): This function returns information about the account's MySQL® host. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ## Database Management MySQL and MariaDB / Database Management ### Validate MySQL database integrity - [GET /Mysql/check_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-check_database.md): This function checks for errors in all of the tables in a MySQL® database. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Create MySQL database - [GET /Mysql/create_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/create_database.md): This function creates a MySQL® database. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Delete MySQL database - [GET /Mysql/delete_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/delete_database.md): This function deletes a MySQL® database. when you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Return MySQL database schema - [GET /Mysql/dump_database_schema](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/dump_database_schema.md): This function returns a string that you can give to MySQL® to recreate a particular database’s schema. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Return MySQL databases - [GET /Mysql/list_databases](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/list_databases.md): This function lists an account's MySQL® databases. When you disable the role remote MySQL is configured, the system this function. ### Update MySQL database name - [GET /Mysql/rename_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-rename_database.md): This function renames a MySQL® database. MySQL does not allow you to rename a database. When cPanel & WHM "renames" a database, the system performs the following steps: 1. The system creates a new database. 2. The system moves data from the old database to the new database. 3. The system recreates grants and stored code in the new database. 4. The system deletes the old database and its grants. * It is potentially dangerous to rename a MySQL database. We recommend that you perform a backup of the database before you attempt to rename it. * If any of the first three steps fail, the system returns an error and attempts to restore the database's original state. If the restoration process fails, the API function's error response describes these additional failures. * In rare cases, the system creates the second database successfully, but fails to delete the old database or grants. The system treats the rename action as a success; however, the API function returns warnings that describe the failure to delete the old database or grants. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Repair MySQL database tables - [GET /Mysql/repair_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/repair_database.md): This function repairs all of the tables in a MySQL® database. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Create a randomly named MySQL username/database set. - [GET /Mysql/setup_db_and_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/setup_db_and_user.md): This function creates a randomly named MySQL® database and user. This allows a 3rdparty tool to create its own DB without needing any knowledge of cPanel internals such as quotas or other limits. These will simply be passed back as an error. When you disable the MySQL/MariaDB role remote MySQL is already configured, the system this function. ### Update MySQL® privileges - [GET /Mysql/update_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/database-management/mysql-update_privileges.md): This function updates privileges for all MySQL® databases and users on an account. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ## Remote Databases MySQL and MariaDB / Remote Databases ### Enable remote MySQL host access - [GET /Mysql/add_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/add_host.md): This function authorizes a remote MySQL® host to access the account's databases. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Add remote MySQL host note - [GET /Mysql/add_host_note](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/mysql-add_host_note.md): This function adds a note about a remote MySQL® server. * If you attempt to add a note to an unauthorized remote MySQL server, the function will fail. * When you the MySQL role, the system disables this function. ### Disable remote MySQL host access - [GET /Mysql/delete_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/delete_host.md): This function removes a remote MySQL® host's access to the account's databases. When you disable the MySQL role and remote MySQL is not already configured, the system this function. ### Return remote MySQL host notes - [GET /Mysql/get_host_notes](https://api.docs.cpanel.net/specifications/cpanel.openapi/remote-databases/get_host_notes.md): This function returns the notes associated with the account's remote MySQL® hosts. When you disable the role remote MySQL is already configured, the system this function. ## User Management MySQL and MariaDB / User Management ### Create MySQL user - [GET /Mysql/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-create_user.md): This function creates a MySQL® database user. When you the MySQL role and remote MySQL is not already configured, the system disables this function. ### Delete MySQL user - [GET /Mysql/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql::delete_user.md): This function deletes a MySQL® user. When you disable the MySQL role and remote MySQL is not already configured, the system this function. ### Return MySQL user privileges - [GET /Mysql/get_privileges_on_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-get_privileges_on_database.md): This function lists a MySQL® database user's privileges. When you disable the MySQL role and remote MySQL is not already configured, the system disables this function. ### Return MySQL name length restrictions - [GET /Mysql/get_restrictions](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/get_restrictions.md): This function lists a MySQL® database's name, username length restrictions, and database prefix. When you disable the role remote MySQL is already configured, the system this function. ### Return MySQL user routines - [GET /Mysql/list_routines](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/list_routines.md): This function returns a database user's MySQL® routines. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Return MySQL users - [GET /Mysql/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-list_users.md): This function lists an account's MySQL® database users. When you disable the MySQL/MariaDB role remote MySQL is configured, the system this function. ### Update MySQL username - [GET /Mysql/rename_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/rename_user.md): This function renames a MySQL® database user. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Remove MySQL user privileges - [GET /Mysql/revoke_access_to_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/revoke_access_to_database.md): This function revokes a MySQL® database user's privileges. When you disable the MySQL role remote MySQL is already configured, the system this function. ### Update MySQL user password - [GET /Mysql/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/mysql-set_password.md): This function sets a MySQL® database user's password. When you disable the MySQL role and remote MySQL is already configured, the system this function. ### Update MySQL user privileges - [GET /Mysql/set_privileges_on_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/user-management/set_privileges_on_database.md): This function sets a MySQL® database user's privileges. When you disable the role, remote MySQL is already configured, the system this function. ## Pushbullet The Pushbullet module for UAPI. ### Validate Pushbullet token - [GET /Pushbullet/send_test_message](https://api.docs.cpanel.net/specifications/cpanel.openapi/pushbullet/send_test_message.md): This function sends a Pushbullet™ test message to determine that the token is valid and that the account holder can receive the message. ## ClamScanner The ClamScanner module provides methods for ClamAV® virus scans and disinfection. ### Request disinfection process status - [GET /ClamScanner/check_disinfection_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::check_disinfection_status.md): This function checks the status of the previously queued disinfection of infected files. You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. If you want to display the progress, you can render the returned 'result{data}{details}' array where the is . Each record indicates the action taken on a specific file in the set being processed. ### Start disinfecting files with viruses - [POST /ClamScanner/disinfect_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/disinfect_files.md): This function applies the disinfection option selected by the user for each infected file. You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Return virus scan types - [GET /ClamScanner/get_scan_paths](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::get_scan_paths.md): This function gets the available local paths that a cPanel account is permitted to scan. : The system determines the available scan types based on what the system administrator has set in WHM's Configure ClamAV® page. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Request virus scan status - [GET /ClamScanner/get_scan_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::get_scan_status.md): This function gets the status of a ClamAV® scan on a directory. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Return infected file list - [GET /ClamScanner/list_infected_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::list_infected_files.md): This function lists infected files from a ClamAV® virus scan. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Start virus scan - [GET /ClamScanner/start_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::start_scan.md): This function starts a ClamAV® scan on a directory. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ## Antivirus Protection (ClamAV) Optional Applications / Antivirus Protection (ClamAV) ### Request disinfection process status - [GET /ClamScanner/check_disinfection_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::check_disinfection_status.md): This function checks the status of the previously queued disinfection of infected files. You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. If you want to display the progress, you can render the returned 'result{data}{details}' array where the is . Each record indicates the action taken on a specific file in the set being processed. ### Start disinfecting files with viruses - [POST /ClamScanner/disinfect_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/disinfect_files.md): This function applies the disinfection option selected by the user for each infected file. You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Return virus scan types - [GET /ClamScanner/get_scan_paths](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::get_scan_paths.md): This function gets the available local paths that a cPanel account is permitted to scan. : The system determines the available scan types based on what the system administrator has set in WHM's Configure ClamAV® page. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Request virus scan status - [GET /ClamScanner/get_scan_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::get_scan_status.md): This function gets the status of a ClamAV® scan on a directory. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Return infected file list - [GET /ClamScanner/list_infected_files](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::list_infected_files.md): This function lists infected files from a ClamAV® virus scan. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ### Start virus scan - [GET /ClamScanner/start_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/antivirus-protection-(clamav)/clamscanner::start_scan.md): This function starts a ClamAV® scan on a directory. : You must run the APIs in this order: 1. Run to start the virus scan. 2. Run in a loop until the scan is finished. 3. Run to get a report of the complete list of infected files. 4. Decide how you want to handle each infected file. 5. Run to queue the disinfection of the files. 6. Run in a loop until you get a done status. ## DAV The DAV module for UAPI. ### Share a calendar - [GET /CPDAVD/add_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_add_delegate.md): This function adds a share for the specified calendar. ### List calendar sharing. - [GET /CPDAVD/list_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_list_delegates.md): This function lists the sharing configuration in calendars for this account. ### Update calendar sharing - [GET /CPDAVD/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_list_users.md): This function lists the users that are available for use with CalDAV and CardDAV ### Perform an operation on a calendar, task list or address book. - [GET /CPDAVD/manage_collection](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_manage_collection.md): This function creates, updates, or deletes a collection. ### Remove a share. - [GET /CPDAVD/remove_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_remove_delegate.md): This function removes a share for the specified calendar. ### Update calendar sharing. - [GET /CPDAVD/update_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_update_delegate.md): This function updates a share for the specified calendar. ### Disable global address book - [GET /DAV/disable_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/disable_shared_global_addressbook.md): This function disables the shared global address book for the current cPanel account's webmail accounts. ### Enable global address book - [GET /DAV/enable_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/enable_shared_global_addressbook.md): This function enables the shared global address book for the current cPanel account's webmail accounts. ### Return CalDAV and CardDAV connection information - [GET /DAV/get_calendar_contacts_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/get_calendar_contacts_config.md): This function returns the connection information to set up the CalDAV and CardDAV clients. ### Return whether global address book is enabled - [GET /DAV/has_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/has_shared_global_addressbook.md): This function checks whether the shared global address book is enabled on the current cPanel account's webmail accounts. ### Return whether DAV is enabled - [GET /DAV/is_dav_service_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/is_dav_service_enabled.md): This function checks whether the DAV service is enabled. ### Return whether Horde is enabled - [GET /DAV/is_horde_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/is_horde_enabled.md): This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0. ## Calendar and Contacts (DAV) Optional Applications / Calendar and Contacts (DAV) ### Share a calendar - [GET /CPDAVD/add_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_add_delegate.md): This function adds a share for the specified calendar. ### List calendar sharing. - [GET /CPDAVD/list_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_list_delegates.md): This function lists the sharing configuration in calendars for this account. ### Update calendar sharing - [GET /CPDAVD/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_list_users.md): This function lists the users that are available for use with CalDAV and CardDAV ### Perform an operation on a calendar, task list or address book. - [GET /CPDAVD/manage_collection](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_manage_collection.md): This function creates, updates, or deletes a collection. ### Remove a share. - [GET /CPDAVD/remove_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_remove_delegate.md): This function removes a share for the specified calendar. ### Update calendar sharing. - [GET /CPDAVD/update_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/cpdavd_update_delegate.md): This function updates a share for the specified calendar. ### Disable global address book - [GET /DAV/disable_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/disable_shared_global_addressbook.md): This function disables the shared global address book for the current cPanel account's webmail accounts. ### Enable global address book - [GET /DAV/enable_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/enable_shared_global_addressbook.md): This function enables the shared global address book for the current cPanel account's webmail accounts. ### Return CalDAV and CardDAV connection information - [GET /DAV/get_calendar_contacts_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/get_calendar_contacts_config.md): This function returns the connection information to set up the CalDAV and CardDAV clients. ### Return whether global address book is enabled - [GET /DAV/has_shared_global_addressbook](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/has_shared_global_addressbook.md): This function checks whether the shared global address book is enabled on the current cPanel account's webmail accounts. ### Return whether DAV is enabled - [GET /DAV/is_dav_service_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/is_dav_service_enabled.md): This function checks whether the DAV service is enabled. ### Return whether Horde is enabled - [GET /DAV/is_horde_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-(dav)/is_horde_enabled.md): This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0. ## CCS The CCS module for UAPI. ### Add calendar delegation - [GET /CCS/add_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/add_delegate.md): This function delegates a user's calendar to another user. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### List cPanel account's calendar delegates - [GET /CCS/list_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/list_delegates.md): This function lists all calendar delegates on the cPanel account. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### List cPanel account's calendar users - [GET /CCS/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/list_users.md): This function lists all calendar users on the cPanel account. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### Remove calendar delegation - [GET /CCS/remove_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/remove_delegate.md): This function removes a delegate from another user's calendar. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### Update calendar delegation - [GET /CCS/update_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/update_delegate.md): This function updates the delegation of a user's calendar to another user. You install the Calendar and Contacts Server cPanel plugin to access this API function. ## Calendar and Contacts Server Optional Applications / Calendar and Contacts Server ### Add calendar delegation - [GET /CCS/add_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/add_delegate.md): This function delegates a user's calendar to another user. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### List cPanel account's calendar delegates - [GET /CCS/list_delegates](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/list_delegates.md): This function lists all calendar delegates on the cPanel account. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### List cPanel account's calendar users - [GET /CCS/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/list_users.md): This function lists all calendar users on the cPanel account. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### Remove calendar delegation - [GET /CCS/remove_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/remove_delegate.md): This function removes a delegate from another user's calendar. You install the Calendar and Contacts Server cPanel plugin to access this API function. ### Update calendar delegation - [GET /CCS/update_delegate](https://api.docs.cpanel.net/specifications/cpanel.openapi/calendar-and-contacts-server/update_delegate.md): This function updates the delegation of a user's calendar to another user. You install the Calendar and Contacts Server cPanel plugin to access this API function. ## cPAddons The cPAddons module for UAPI. ### Return available cPAddons - [GET /cPAddons/get_available_addons](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/get_available_addons.md): This function lists an account's available cPAddons. ### Return deployed cPAddons instance's settings - [GET /cPAddons/get_instance_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/get_instance_settings.md): This function lists a cPAddons instance's settings. ### Return deployed cPAddons instances - [GET /cPAddons/list_addon_instances](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/list_addon_instances.md): This function lists an account's deployed cPAddons instances. ## cPanel Addons (cPAddons) Optional Applications / cPanel Addons (cPAddons) ### Return available cPAddons - [GET /cPAddons/get_available_addons](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/get_available_addons.md): This function lists an account's available cPAddons. ### Return deployed cPAddons instance's settings - [GET /cPAddons/get_instance_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/get_instance_settings.md): This function lists a cPAddons instance's settings. ### Return deployed cPAddons instances - [GET /cPAddons/list_addon_instances](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-addons-(cpaddons)/list_addon_instances.md): This function lists an account's deployed cPAddons instances. ## WordPressBackup The WordPressBackup module for UAPI. ### Return all WordPress sites' backup status - [GET /WordPressBackup/any_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/any_running.md): This function checks for any active WordPress® site backups on the cPanel account. You install the WordPress Manager cPanel plugin to access this API function. ### Stop WordPress site backup - [GET /WordPressBackup/cancel](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/cancel.md): This function cancels a WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Delete WordPress backup temporary files - [GET /WordPressBackup/cleanup](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/cleanup.md): This function releases any system resources from a previous WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site backups - [GET /WordPressBackup/get_available_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/get_available_backups.md): This function retrieves a list of available WordPress® site backups of a single site. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site backup status - [GET /WordPressBackup/is_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/is_running.md): This function checks for an active WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Backup WordPress site - [GET /WordPressBackup/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/start.md): This function starts a single WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ## WordPress Manager Backups Optional Applications / WordPress Manager Backups ### Return all WordPress sites' backup status - [GET /WordPressBackup/any_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/any_running.md): This function checks for any active WordPress® site backups on the cPanel account. You install the WordPress Manager cPanel plugin to access this API function. ### Stop WordPress site backup - [GET /WordPressBackup/cancel](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/cancel.md): This function cancels a WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Delete WordPress backup temporary files - [GET /WordPressBackup/cleanup](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/cleanup.md): This function releases any system resources from a previous WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site backups - [GET /WordPressBackup/get_available_backups](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/get_available_backups.md): This function retrieves a list of available WordPress® site backups of a single site. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site backup status - [GET /WordPressBackup/is_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/is_running.md): This function checks for an active WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Backup WordPress site - [GET /WordPressBackup/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/start.md): This function starts a single WordPress® site backup. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site restore status - [GET /WordPressRestore/any_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore::any_running.md): This function returns whether a WordPress® site backup restoration is in progress. * You install the WordPress Manager cPanel plugin to access this API function. * The output of this function changes, depending on the state of the backup restoration. ### Delete restored WordPress site's temporary files - [GET /WordPressRestore/cleanup](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore-cleanup.md): This function cleans up any temporary system resources after a WordPress® site backup restoration. You install the WordPress Manager cPanel plugin to access this API function. ### Restore WordPress site - [GET /WordPressRestore/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore-start.md): This function starts a single WordPress® site backup restoration. You install the WordPress Manager cPanel plugin to access this API function. ## WordPressRestore The WordPressRestore module for UAPI. ### Return WordPress site restore status - [GET /WordPressRestore/any_running](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore::any_running.md): This function returns whether a WordPress® site backup restoration is in progress. * You install the WordPress Manager cPanel plugin to access this API function. * The output of this function changes, depending on the state of the backup restoration. ### Delete restored WordPress site's temporary files - [GET /WordPressRestore/cleanup](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore-cleanup.md): This function cleans up any temporary system resources after a WordPress® site backup restoration. You install the WordPress Manager cPanel plugin to access this API function. ### Restore WordPress site - [GET /WordPressRestore/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-backups/wordpressrestore-start.md): This function starts a single WordPress® site backup restoration. You install the WordPress Manager cPanel plugin to access this API function. ## WordPressInstanceManager The WordPressInstanceManager module for UAPI. ### Stop WordPress site scan - [GET /WordPressInstanceManager/cancel_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cancel_scan.md): This function cancels a scan that you start with the function. You install the WordPress Manager cPanel plugin to access this API function. ### Update WordPress site admin password - [GET /WordPressInstanceManager/change_admin_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/change_admin_password.md): This function updates a WordPress® cPAddon instance's administrator password. You install the WordPress Manager cPanel plugin to access this API function. ### Remove scan log after completed scan - [GET /WordPressInstanceManager/cleanup_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cleanup_scan.md): This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation. You install the WordPress Manager cPanel plugin to access this API function. ### Update WordPress site automatic update settings - [GET /WordPressInstanceManager/configure_autoupdate](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/configure_autoupdate.md): This function configures a WordPress cPAddon instance's automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon. This function changes the instance's automatic update setting in the file. Before you run this function, you should verify that a filter does exist for the automatic update settings. Use the function and view the return to determine if a filter exists. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress Manager plugin version - [GET /WordPressInstanceManager/get_api_version](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_api_version.md): This function retrieves the WordPress Manager plugin's version. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site settings - [GET /WordPressInstanceManager/get_instance_by_id](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instance_by_id.md): This function retrieves a WordPress® instance's configuration. * You install the WordPress Manager cPanel plugin to access this API function. * This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes. ### Return WordPress sites - [GET /WordPressInstanceManager/get_instances](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instances.md): This function lists an account's WordPress® instances. * You install the WordPress Manager cPanel plugin to access this API function. * This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes. ### Return latest wordpress.org updates - [GET /WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_latest_wordpress_version_from_wordpress_org.md): This function returns the available WordPress® updates from wordpress.org. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site scan results - [GET /WordPressInstanceManager/get_scan_results](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_scan_results.md): This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for . You install the WordPress Manager cPanel plugin to access this API function. ### Verify WordPress cPAddon availability - [GET /WordPressInstanceManager/is_installable_addon_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/is_installable_addon_available.md): This function verifies that the RPM-based WordPress® cPAddon exists on the system. You must install the WordPress Manager cPanel plugin to access this API function. ### Start WordPress sites scan - [GET /WordPressInstanceManager/start_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/wordpressinstancemanager-start_scan.md): This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel's WordPress Manager interface with any newly discovered instances. You install the WordPress Manager cPanel plugin to access this API function. ### Server Sent Events (SSE) This function uses the following SSE events: * — The scan operation discovered a WordPress instance and registered it. The data is a JSON-encoded object containing the attributes of the instance, with the same format used in the UAPI and UAPI functions. * — The scan operation found a WordPress instance. If the WordPress instance is newly discovered, the system will also generate a event for the instance. The data is a JSON-encoded object containing the following: * — The absolute file path to the instance. * — The scan is finished. The data is a JSON-encoded object that contains: * — An array of strings that represents the absolute path to the discovered instances and any instances that the system already registered. *  — An array of converted instances that the system returns in the same format provided in the UAPI and UAPI functions. * — The system or user terminated the scan. * — The scan timed out before it completed. * — The system failed to build the instance registry. The data is a JSON-encoded string that contains the error message. * — The system could not load the registry after building the instance registry. The data is a JSON-encoded string that contains the error message. For more information about server sent events, read Mozilla's Using server-sent events documentation. ## WordPress Manager Settings Optional Applications / WordPress Manager Settings ### Stop WordPress site scan - [GET /WordPressInstanceManager/cancel_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cancel_scan.md): This function cancels a scan that you start with the function. You install the WordPress Manager cPanel plugin to access this API function. ### Update WordPress site admin password - [GET /WordPressInstanceManager/change_admin_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/change_admin_password.md): This function updates a WordPress® cPAddon instance's administrator password. You install the WordPress Manager cPanel plugin to access this API function. ### Remove scan log after completed scan - [GET /WordPressInstanceManager/cleanup_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cleanup_scan.md): This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation. You install the WordPress Manager cPanel plugin to access this API function. ### Update WordPress site automatic update settings - [GET /WordPressInstanceManager/configure_autoupdate](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/configure_autoupdate.md): This function configures a WordPress cPAddon instance's automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon. This function changes the instance's automatic update setting in the file. Before you run this function, you should verify that a filter does exist for the automatic update settings. Use the function and view the return to determine if a filter exists. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress Manager plugin version - [GET /WordPressInstanceManager/get_api_version](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_api_version.md): This function retrieves the WordPress Manager plugin's version. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site settings - [GET /WordPressInstanceManager/get_instance_by_id](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instance_by_id.md): This function retrieves a WordPress® instance's configuration. * You install the WordPress Manager cPanel plugin to access this API function. * This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes. ### Return WordPress sites - [GET /WordPressInstanceManager/get_instances](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instances.md): This function lists an account's WordPress® instances. * You install the WordPress Manager cPanel plugin to access this API function. * This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes. ### Return latest wordpress.org updates - [GET /WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_latest_wordpress_version_from_wordpress_org.md): This function returns the available WordPress® updates from wordpress.org. You install the WordPress Manager cPanel plugin to access this API function. ### Return WordPress site scan results - [GET /WordPressInstanceManager/get_scan_results](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_scan_results.md): This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for . You install the WordPress Manager cPanel plugin to access this API function. ### Verify WordPress cPAddon availability - [GET /WordPressInstanceManager/is_installable_addon_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/is_installable_addon_available.md): This function verifies that the RPM-based WordPress® cPAddon exists on the system. You must install the WordPress Manager cPanel plugin to access this API function. ### Start WordPress sites scan - [GET /WordPressInstanceManager/start_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/wordpressinstancemanager-start_scan.md): This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel's WordPress Manager interface with any newly discovered instances. You install the WordPress Manager cPanel plugin to access this API function. ### Server Sent Events (SSE) This function uses the following SSE events: * — The scan operation discovered a WordPress instance and registered it. The data is a JSON-encoded object containing the attributes of the instance, with the same format used in the UAPI and UAPI functions. * — The scan operation found a WordPress instance. If the WordPress instance is newly discovered, the system will also generate a event for the instance. The data is a JSON-encoded object containing the following: * — The absolute file path to the instance. * — The scan is finished. The data is a JSON-encoded object that contains: * — An array of strings that represents the absolute path to the discovered instances and any instances that the system already registered. *  — An array of converted instances that the system returns in the same format provided in the UAPI and UAPI functions. * — The system or user terminated the scan. * — The scan timed out before it completed. * — The system failed to build the instance registry. The data is a JSON-encoded string that contains the error message. * — The system could not load the registry after building the instance registry. The data is a JSON-encoded string that contains the error message. For more information about server sent events, read Mozilla's Using server-sent events documentation. ## Postgresql The Postgresql module for UAPI. ### Create PostgreSQL database - [GET /Postgresql/create_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::create_database.md): This function creates a PostgreSQL® database. When you disable the PostgreSQL role, the system this function. ### Delete PostgreSQL database - [GET /Postgresql/delete_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::delete_database.md): This function deletes a PostgreSQL® database. When you disable the Postgres role, the system this function. ### Return PostgreSQL name length restrictions - [GET /Postgresql/get_restrictions](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::get_restrictions.md): This function retrieves the PostgreSQL® user and database name length restrictions. When you disable the role, the system this function. ### Return PostgreSQL databases - [GET /Postgresql/list_databases](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql-list_databases.md): This function lists an account's PostgreSQL® databases. When you disable the role, the system this function. ### Update PostgreSQL database name - [GET /Postgresql/rename_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/rename_database.md): This function renames a PostgreSQL® database. When you disable the role, the system this function. ### Create PostgreSQL user - [GET /Postgresql/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/create_user.md): This function creates a PostgreSQL® database user. When you disable the role, the system this function. ### Delete PostgreSQL user - [GET /Postgresql/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::delete_user.md): This function deletes a PostgreSQL® user. When you disable the PostgreSQL role, the system this function. ### Enable all user privileges on PostgreSQL database - [GET /Postgresql/grant_all_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/grant_all_privileges.md): This function grants all privileges for a PostgreSQL® database to a database user. When you disable the role, the system this function. ### Return PostgreSQL users - [GET /Postgresql/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::list_users.md): This function lists an account's PostgreSQL® database users. When you disable the role, the system this function. ### Update PostgreSQL username - [GET /Postgresql/rename_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::rename_user.md): This function renames a PostgreSQL® database user. When you disable the role, the system this function. ### Update PostgreSQL username without password - [GET /Postgresql/rename_user_no_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/rename_user_no_password.md): This function renames a PostgreSQL® database user. * If you rename a PostgreSQL user, you set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords. * We recommend that you use the instead of this one. When you disable the role, the system this function. ### Remove PostgreSQL user privileges - [GET /Postgresql/revoke_all_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/revoke_all_privileges.md): This function revokes all privileges for a PostgreSQL® database from a database user. When you disable the role, the system this function. ### Update PostgreSQL user password - [GET /Postgresql/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/set_password.md): This function changes a PostgreSQL® database user's password. When you disable the Postgres role, the system this function. ### Update PostgreSQL® privileges - [GET /Postgresql/update_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql-update_privileges.md): This function synchronizes PostgreSQL® database user privileges on an account. Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants, wildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and you want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this API function or click _Synchronize Grants_ in the _PostgreSQL Databases_ interface (_Home >> Databases >> PostgreSQL Databases_) after you add a table. When you disable the PostgreSQL role, the system this function. ## PostgreSQL Database Management PostgreSQL / Database Management ### Create PostgreSQL database - [GET /Postgresql/create_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::create_database.md): This function creates a PostgreSQL® database. When you disable the PostgreSQL role, the system this function. ### Delete PostgreSQL database - [GET /Postgresql/delete_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::delete_database.md): This function deletes a PostgreSQL® database. When you disable the Postgres role, the system this function. ### Return PostgreSQL name length restrictions - [GET /Postgresql/get_restrictions](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql::get_restrictions.md): This function retrieves the PostgreSQL® user and database name length restrictions. When you disable the role, the system this function. ### Return PostgreSQL databases - [GET /Postgresql/list_databases](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/postgresql-list_databases.md): This function lists an account's PostgreSQL® databases. When you disable the role, the system this function. ### Update PostgreSQL database name - [GET /Postgresql/rename_database](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-database-management/rename_database.md): This function renames a PostgreSQL® database. When you disable the role, the system this function. ## PostgreSQL User Management PostgreSQL / User Management ### Create PostgreSQL user - [GET /Postgresql/create_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/create_user.md): This function creates a PostgreSQL® database user. When you disable the role, the system this function. ### Delete PostgreSQL user - [GET /Postgresql/delete_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::delete_user.md): This function deletes a PostgreSQL® user. When you disable the PostgreSQL role, the system this function. ### Enable all user privileges on PostgreSQL database - [GET /Postgresql/grant_all_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/grant_all_privileges.md): This function grants all privileges for a PostgreSQL® database to a database user. When you disable the role, the system this function. ### Return PostgreSQL users - [GET /Postgresql/list_users](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::list_users.md): This function lists an account's PostgreSQL® database users. When you disable the role, the system this function. ### Update PostgreSQL username - [GET /Postgresql/rename_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql::rename_user.md): This function renames a PostgreSQL® database user. When you disable the role, the system this function. ### Update PostgreSQL username without password - [GET /Postgresql/rename_user_no_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/rename_user_no_password.md): This function renames a PostgreSQL® database user. * If you rename a PostgreSQL user, you set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords. * We recommend that you use the instead of this one. When you disable the role, the system this function. ### Remove PostgreSQL user privileges - [GET /Postgresql/revoke_all_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/revoke_all_privileges.md): This function revokes all privileges for a PostgreSQL® database from a database user. When you disable the role, the system this function. ### Update PostgreSQL user password - [GET /Postgresql/set_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/set_password.md): This function changes a PostgreSQL® database user's password. When you disable the Postgres role, the system this function. ### Update PostgreSQL® privileges - [GET /Postgresql/update_privileges](https://api.docs.cpanel.net/specifications/cpanel.openapi/postgresql-user-management/postgresql-update_privileges.md): This function synchronizes PostgreSQL® database user privileges on an account. Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants, wildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and you want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this API function or click _Synchronize Grants_ in the _PostgreSQL Databases_ interface (_Home >> Databases >> PostgreSQL Databases_) after you add a table. When you disable the PostgreSQL role, the system this function. ## Bandwidth The Bandwidth module for UAPI. ### Return services monitored in bandwidth data - [GET /Bandwidth/get_enabled_protocols](https://api.docs.cpanel.net/specifications/cpanel.openapi/bandwidth/get_enabled_protocols.md): This function returns a list of the server's enabled protocols. ### Return bandwidth retention period - [GET /Bandwidth/get_retention_periods](https://api.docs.cpanel.net/specifications/cpanel.openapi/bandwidth/get_retention_periods.md): This function retrieves the retention periods for bandwidth data. ### Return cPanel account's bandwidth usage report - [GET /Bandwidth/query](https://api.docs.cpanel.net/specifications/cpanel.openapi/bandwidth/query.md): This function queries an account's bandwidth data and returns a report. This function also returns the bandwidth use of a distributed cPanel account. ## KnownHosts The KnownHosts module for UAPI. ### Create host - [GET /KnownHosts/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/create.md): This function registers a host in the cPanel account's  file. ### Delete host - [GET /KnownHosts/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/knownhosts::delete.md): This function removes a host from the cPanel account's  file. ### Update host in the known_hosts file - [GET /KnownHosts/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/knownhosts::update.md): This function updates a host's entry in the cPanel account's /home/user/.ssh/known_hosts file. ### Validate host - [GET /KnownHosts/verify](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/verify.md): This function checks whether a host's public key exists in the cPanel account's  file. ## Known SSH Hosts Management Security / Known SSH Hosts Management ### Create host - [GET /KnownHosts/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/create.md): This function registers a host in the cPanel account's  file. ### Delete host - [GET /KnownHosts/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/knownhosts::delete.md): This function removes a host from the cPanel account's  file. ### Update host in the known_hosts file - [GET /KnownHosts/update](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/knownhosts::update.md): This function updates a host's entry in the cPanel account's /home/user/.ssh/known_hosts file. ### Validate host - [GET /KnownHosts/verify](https://api.docs.cpanel.net/specifications/cpanel.openapi/known-ssh-hosts-management/verify.md): This function checks whether a host's public key exists in the cPanel account's  file. ## LastLogin The LastLogin module for UAPI. ### Return last authenticated login IP address - [GET /LastLogin/get_last_or_current_logged_in_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/login-information/get_last_or_current_logged_in_ip.md): This function returns the IP address of the user who most recently logged in. ## Login Information Security / Login Information ### Return last authenticated login IP address - [GET /LastLogin/get_last_or_current_logged_in_ip](https://api.docs.cpanel.net/specifications/cpanel.openapi/login-information/get_last_or_current_logged_in_ip.md): This function returns the IP address of the user who most recently logged in. ### Return web server's hostname - [GET /Variables/get_session_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/login-information/get_session_information.md): This function retrieves a web server's hostname. ## ServerInformation The ServerInformation module for UAPI. ### Return service and device status - [GET /ServerInformation/get_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-server-information/get_information.md): This function returns the status of each cPanel service (daemon), device, and server health check point on your server. ## cPanel Server Information Server Information / Server Information ### Return service and device status - [GET /ServerInformation/get_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-server-information/get_information.md): This function returns the status of each cPanel service (daemon), device, and server health check point on your server. ### Return server's configuration settings - [GET /Variables/get_server_information](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-server-information/variables-get_server_information.md): This function retrieves the configuration settings for the cPanel & WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account. ## Notifications The Notifications module for UAPI. ### Return server notifications total - [GET /Notifications/get_notifications_count](https://api.docs.cpanel.net/specifications/cpanel.openapi/notifications/get_notifications_count.md): This function returns the number of server-wide notifications on an account. ## PasswdStrength The PasswdStrength module for UAPI. ### Return minimum required password strength - [GET /PasswdStrength/get_required_strength](https://api.docs.cpanel.net/specifications/cpanel.openapi/password-strength/get_required_strength.md): This function retrieves an application's minimum required password strength. ## Password Strength Server Information / Password Strength ### Return minimum required password strength - [GET /PasswdStrength/get_required_strength](https://api.docs.cpanel.net/specifications/cpanel.openapi/password-strength/get_required_strength.md): This function retrieves an application's minimum required password strength. ## SSH The SSH module for UAPI. ### Return SSH port - [GET /SSH/get_port](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssh/ssh-get_port.md): This function retrieves the server's SSH port. ### Return whether cPanel account has shell access - [GET /ssh/get_shell](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssh/paths/~1ssh~1get_shell/get.md): This function returns whether the cPanel account has shell access and the account's shell path. ## ServiceProxy The ServiceProxy module for UAPI. ### Return a cPanel account’s service proxying setup - [GET /ServiceProxy/get_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-get_service_proxy_backends.md): This function reports a cPanel account's service proxying configuration. ### Add cPanel account service proxying - [GET /ServiceProxy/set_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-set_service_proxy_backends.md): This function lets you configure a cPanel account's service proxying. * If the Web Server role is active on the server, this function rebuilds the user's web virtual hosts (vhosts) and restarts the web server. * If the system cannot rebuild the user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata. * To remove an account's service proxying, use the UAPI function. ### Remove cPanel account service proxying - [GET /ServiceProxy/unset_all_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-unset_all_service_proxy_backends.md): This function removes a cPanel account's service proxying. * If the Web Server role is active on the server, this function rebuilds the cPanel user's web virtual hosts (vhosts) and restarts the web server. * If the system rebuild the cPanel user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata. * To set a service proxying for a cPanel account, use the UAPI function. ## SiteQuality The SiteQuality module for UAPI. ### Add domain to monitoring - [POST /SiteQuality/create_project](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-create_project.md): This function creates a Site Quality Monitoring project. A project bundles together one or more URLs with a shared domain for monitoring. ### Register cPanel user for monitoring - [POST /SiteQuality/create_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-create_site_quality_user.md): This function creates a Site Quality Monitoring user account associated with a cPanel user account. ### Delete Site Quality Monitoring account - [GET /SiteQuality/delete_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-delete_site_quality_user.md): This function initiates the deletion of the Site Quality Monitoring user account associated with a cPanel user account. ### Return all projects' monitoring results - [POST /SiteQuality/get_all_scores](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-get_all_scores.md): This function returns information about the cPanel user's Site Quality Monitoring projects' most recent monitoring check results. ### Return koality authentication token - [GET /SiteQuality/get_app_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-get_app_token.md): This function returns the long-lived application token used to authenticate with koality's authentication servers. ### Validate monitoring account existence - [GET /SiteQuality/has_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-has_site_quality_user.md): This function returns whether the cPanel user has an associated Site Quality Monitoring account. ### Validate monitoring account enablement - [GET /SiteQuality/is_site_quality_user_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-is_site_quality_user_enabled.md): This function verifies that koality has enabled the cPanel user's Site Quality Monitoring account. ### Remove monitoring user from cPanel configuration - [GET /SiteQuality/reset_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-reset_config.md): This function will remove Site Quality Monitoring account data from the cPanel user's configuration. * This function will prevent cPanel & WHM from automatically logging the user into their Site Quality Monitoring account. * This function does not delete the Site Quality Monitoring account from the koality servers. ### Request activation email - [GET /SiteQuality/send_activation_email](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-send_activation_email.md): This function sends a Site Quality Monitoring activation email to the currently-authenticated Site Quality Monitoring user. This email contains the Site Quality Monitoring activation code. ### Update domain name in Site Quality Monitoring project - [POST /SiteQuality/update_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-update_domain.md): This function updates the domain name for a Site Quality Monitoring project. It searches through all projects owned by the user to find systems that match the specified old domain and updates them to use the new domain. This is typically used when a website's domain name changes and the monitoring configuration needs to be updated accordingly. ### Validate activation code - [GET /SiteQuality/verify_code](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-verify_code.md): This function validates the activation code in a cPanel user's Site Quality Monitoring registration email. ## SSL The SSL module for UAPI. ### Disable AutoSSL for domains - [GET /SSL/add_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/add_autossl_excluded_domains.md): This function disables AutoSSL for the domains that you specify. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return AutoSSL disabled domains - [GET /SSL/get_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/get_autossl_excluded_domains.md): This function lists the domains with AutoSSL disabled. ### Return domains with AutoSSL problems - [GET /SSL/get_autossl_problems](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/get_autossl_problems.md): This function retrieves a list of domains that possess AutoSSL problems. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return whether AutoSSL check in progress - [GET /SSL/is_autossl_check_in_progress](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/is_autossl_check_in_progress.md): This function verifies whether the task is in progress for the current user. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Enable AutoSSL for specifed domains - [GET /SSL/remove_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/remove_autossl_excluded_domains.md): This function enables AutoSSL for the domains that you specify. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Disable AutoSSL for specifed domains - [GET /SSL/set_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/set_autossl_excluded_domains.md): This function disables AutoSSL for every domain that you specify. This function the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function . When you disable the the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Start AutoSSL for current user - [GET /SSL/start_autossl_check](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/start_autossl_check.md): This function initiates an AutoSSL check for the user. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return whether domains can redirect to secure URL - [GET /SSL/can_ssl_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/can_ssl_redirect.md): This function determines whether the system can automatically redirect domains on a cPanel account to use SSL. ### Remove SSL for domain - [GET /SSL/delete_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/delete_ssl.md): This function removes SSL from a domain. This function removes domains from the current certificate to end SSL coverage for those domains. To delete certificates from SSL storage, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Request best SSL certificate - [GET /SSL/fetch_best_for_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_best_for_domain.md): This function retrieves the best-available certificate for the domain. The function also retrieves the certificate's associated private key and CA bundle, if available. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL certificate information - [GET /SSL/fetch_cert_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_cert_info.md): This function retrieves all of a certificate's available information. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL certificate information for all FQDN - [GET /SSL/fetch_certificates_for_fqdns](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_certificates_for_fqdns.md): This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns. ### Return private key and CA bundle - [POST /SSL/fetch_key_and_cabundle_for_certificate](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_key_and_cabundle_for_certificate.md): This function extracts the private key and CA bundle information from a certificate. Due to the limited field length of method calls, you use the method. For this reason, you use a cPanel or Webmail session URL to call this function. ### Return SSL certificate for private key - [GET /SSL/find_certificates_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_certificates_for_key.md): This function retrieves SSL certificates for a private key. When you call this function, you include either the the parameter. ### Return private key's certificate signing requests - [GET /SSL/find_csrs_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_csrs_for_key.md): This function retrieves certificate signing requests (CSR) for a private key. When you call this function, you include either the or the parameter. ### Return certificate's CA bundle and hostname - [GET /SSL/get_cabundle](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cabundle.md): This function retrieves a certificate's Certificate Authority (CA) bundle and hostname. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Request best SSL domain for service - [GET /SSL/get_cn_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cn_name.md): This function retrieves the most secure domain for a service. ### Return SSL certificate's info for dedicated IP - [GET /SSL/installed_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_host.md): This function retrieves information about a certificate that is installed on a domain's dedicated IP address. * If you do possess a dedicated IP address, this function will . For non-dedicated IP addresses, use the function. * When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_ , _Webmail_ , _Web Server_ roles, the system this function. ### Return domains with SSL certificate information - [GET /SSL/installed_hosts](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_hosts.md): This function retrieves a list of the account's websites, their domains, and certificate information. For a dedicated IP address, use the UAPI function. When you disable the , , , , and roles, the system this function. ### Return all SSL certificates - [GET /SSL/list_certs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_certs.md): This function lists an account's certificates. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return all certificate signing requests - [GET /SSL/list_csrs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_csrs.md): This function lists an account's certificate signing requests (CSR). When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return all private keys - [GET /SSL/list_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_keys.md): This function lists an account's private keys. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL-related items - [GET /SSL/list_ssl_items](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_ssl_items.md): This function lists SSL-related items on a domain. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Start SSL database rebuild - [GET /SSL/rebuildssldb](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/rebuildssldb.md): This function rebuilds the account's SSL database. ### Update SSL TLS key type - [GET /SSL/set_default_key_type](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/ssl::set_default_key_type.md): This function sets a user’s preferred SSL/TLS key type. ### Enable or disable secure redirects - [GET /SSL/toggle_ssl_redirect_for_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/toggle_ssl_redirect_for_domains.md): This function enables or disables secure redirects (HTTPS) for the cPanel account's domains that you specify. To call this function, one of the following conditions exist: * AutoSSL exist on the domains for which you enable secure redirects. * A valid SSL certificate exist for each domain for which you wish to enable secure redirects. * You own the domains for which you wish to enable secure redirects. ### Return whether shared SSL certificate exists (deprecated) - [GET /SSL/check_shared_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/check_shared_cert.md): This function checks whether a shared SSL certificate is associated with the account. ### Disable SNI mail services for domain - [GET /SSL/disable_mail_sni](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/disable_mail_sni.md): This function disables SNI mail services on the specified domains. Mail SNI is enabled. * After you change the SNI status, you run UAPI's function. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. ### Enable SNI mail services for domain - [GET /SSL/enable_mail_sni](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/enable_mail_sni.md): This function enables SNI mail services on the specified domains. Mail SNI is enabled. * Mail SNI is compatible with Webmail and will function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. When you disable the , , , , roles, the system this function. ### Return whether mail SNI is enabled - [GET /SSL/is_mail_sni_supported](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/is_mail_sni_supported.md): This function checks whether the sslinstall feature is enabled. Mail SNI is always enabled. * Mail SNI is compatible with Webmail and will function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI will fail and make no changes. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return whether Apache web server supports mail SNI - [GET /SSL/is_sni_supported](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/is_sni_supported.md): This function checks whether the Apache web server supports SNI. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return status of domain's SNI mail services - [GET /SSL/mail_sni_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/mail_sni_status.md): This function retrieves the status of the domain's SNI mail services. Mail SNI is compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. Mail SNI is always enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. ### Start SNI configuration files rebuild - [GET /SSL/rebuild_mail_sni_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/rebuild_mail_sni_config.md): This function rebuilds the SNI configuration files. * You run this function after you change the SNI status through the UAPI's or functions. * Mail SNI is enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes. * Functions that disable Mail SNI will fail and make no changes. When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_, _Webmail_, _Web Server_ roles, the system this function. ### Delete SSL certificate - [GET /SSL/delete_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_cert.md): This function deletes an SSL certificate. * When you call this function, you include the or the parameter. * This function deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Delete certificate signing request - [GET /SSL/delete_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_csr.md): This function deletes a certificate signing request (CSR). * When you call this function, you include the or the parameter. * To delete a private key, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Delete private key - [GET /SSL/delete_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_key.md): This function deletes a private key. * When you call this function, you include the or the parameter. * To delete a certificate signing request (CSR), use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Create self-signed SSL certificate - [GET /SSL/generate_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/generate_cert.md): This function generates a self-signed SSL certificate. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Create certificate signing request - [GET /SSL/generate_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/generate_csr.md): This function generates a certificate signing request (CSR). This function a valid key in the account's directory. You can generate a key with UAPI's function. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and WebServer roles, the system this function. ### Create private key - [GET /SSL/generate_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/ssl-generate_key.md): This function generates a private key. * You call both the and parameters in a single call. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Install SSL certificate - [GET /SSL/install_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/install_ssl.md): This function installs an SSL certificate. Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our Call UAPI's SSL::install_ssl Function in Custom Code documentation. When you disable the , , , , and roles, the system this function. ### Update SSL certificate's friendly name - [GET /SSL/set_cert_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_cert_friendly_name.md): This function changes a certificate's friendly name. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update certificate signing request's friendly name - [GET /SSL/set_csr_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_csr_friendly_name.md): This function changes a certificate signing request's (CSR) friendly name. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update private key's friendly name - [GET /SSL/set_key_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_key_friendly_name.md): This function changes a key's friendly name. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update SSL website for dedicated IP address - [GET /SSL/set_primary_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_primary_ssl.md): This function sets a new primary SSL website for a dedicated IP address. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Export SSL certificate - [GET /SSL/show_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_cert.md): This function retrieves a certificate. When you call this parameter, you include either the or the parameter. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Export certificate signing request - [GET /SSL/show_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_csr.md): This function retrieves a certificate signing request (CSR). When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. When you call this function, you include either the or the parameter. ### Export private key - [GET /SSL/show_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_key.md): This function retrieves a private key. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Import SSL certificate - [POST /SSL/upload_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/upload_cert.md): This function uploads a certificate. * Due to the limited field length of HTTP GET method calls, you use the HTTP POST method. For this reason, you use a cPanel or Webmail session URL to call this function. * When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Import private key - [POST /SSL/upload_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/upload_key.md): This function uploads a private key. Due to the limited field length of HTTP GET method calls, you use the HTTP POST method. For this reason, you use a cPanel or Webmail session URL to call this function. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ## Auto-generated SSL Certificates SSL Certificates / Auto-generated SSL Certificates ### Disable AutoSSL for domains - [GET /SSL/add_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/add_autossl_excluded_domains.md): This function disables AutoSSL for the domains that you specify. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return AutoSSL disabled domains - [GET /SSL/get_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/get_autossl_excluded_domains.md): This function lists the domains with AutoSSL disabled. ### Return domains with AutoSSL problems - [GET /SSL/get_autossl_problems](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/get_autossl_problems.md): This function retrieves a list of domains that possess AutoSSL problems. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return whether AutoSSL check in progress - [GET /SSL/is_autossl_check_in_progress](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/is_autossl_check_in_progress.md): This function verifies whether the task is in progress for the current user. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Enable AutoSSL for specifed domains - [GET /SSL/remove_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/remove_autossl_excluded_domains.md): This function enables AutoSSL for the domains that you specify. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Disable AutoSSL for specifed domains - [GET /SSL/set_autossl_excluded_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/set_autossl_excluded_domains.md): This function disables AutoSSL for every domain that you specify. This function the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function . When you disable the the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Start AutoSSL for current user - [GET /SSL/start_autossl_check](https://api.docs.cpanel.net/specifications/cpanel.openapi/auto-generated-ssl-certificates/start_autossl_check.md): This function initiates an AutoSSL check for the user. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ## cPanel Account SSL Management SSL Certificates / cPanel Account SSL Management ### Return whether domains can redirect to secure URL - [GET /SSL/can_ssl_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/can_ssl_redirect.md): This function determines whether the system can automatically redirect domains on a cPanel account to use SSL. ### Remove SSL for domain - [GET /SSL/delete_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/delete_ssl.md): This function removes SSL from a domain. This function removes domains from the current certificate to end SSL coverage for those domains. To delete certificates from SSL storage, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Request best SSL certificate - [GET /SSL/fetch_best_for_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_best_for_domain.md): This function retrieves the best-available certificate for the domain. The function also retrieves the certificate's associated private key and CA bundle, if available. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL certificate information - [GET /SSL/fetch_cert_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_cert_info.md): This function retrieves all of a certificate's available information. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL certificate information for all FQDN - [GET /SSL/fetch_certificates_for_fqdns](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_certificates_for_fqdns.md): This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns. ### Return private key and CA bundle - [POST /SSL/fetch_key_and_cabundle_for_certificate](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_key_and_cabundle_for_certificate.md): This function extracts the private key and CA bundle information from a certificate. Due to the limited field length of method calls, you use the method. For this reason, you use a cPanel or Webmail session URL to call this function. ### Return SSL certificate for private key - [GET /SSL/find_certificates_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_certificates_for_key.md): This function retrieves SSL certificates for a private key. When you call this function, you include either the the parameter. ### Return private key's certificate signing requests - [GET /SSL/find_csrs_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_csrs_for_key.md): This function retrieves certificate signing requests (CSR) for a private key. When you call this function, you include either the or the parameter. ### Return certificate's CA bundle and hostname - [GET /SSL/get_cabundle](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cabundle.md): This function retrieves a certificate's Certificate Authority (CA) bundle and hostname. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Request best SSL domain for service - [GET /SSL/get_cn_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cn_name.md): This function retrieves the most secure domain for a service. ### Return SSL certificate's info for dedicated IP - [GET /SSL/installed_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_host.md): This function retrieves information about a certificate that is installed on a domain's dedicated IP address. * If you do possess a dedicated IP address, this function will . For non-dedicated IP addresses, use the function. * When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_ , _Webmail_ , _Web Server_ roles, the system this function. ### Return domains with SSL certificate information - [GET /SSL/installed_hosts](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_hosts.md): This function retrieves a list of the account's websites, their domains, and certificate information. For a dedicated IP address, use the UAPI function. When you disable the , , , , and roles, the system this function. ### Return all SSL certificates - [GET /SSL/list_certs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_certs.md): This function lists an account's certificates. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return all certificate signing requests - [GET /SSL/list_csrs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_csrs.md): This function lists an account's certificate signing requests (CSR). When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return all private keys - [GET /SSL/list_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_keys.md): This function lists an account's private keys. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return SSL-related items - [GET /SSL/list_ssl_items](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_ssl_items.md): This function lists SSL-related items on a domain. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Start SSL database rebuild - [GET /SSL/rebuildssldb](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/rebuildssldb.md): This function rebuilds the account's SSL database. ### Update SSL TLS key type - [GET /SSL/set_default_key_type](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/ssl::set_default_key_type.md): This function sets a user’s preferred SSL/TLS key type. ### Enable or disable secure redirects - [GET /SSL/toggle_ssl_redirect_for_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/toggle_ssl_redirect_for_domains.md): This function enables or disables secure redirects (HTTPS) for the cPanel account's domains that you specify. To call this function, one of the following conditions exist: * AutoSSL exist on the domains for which you enable secure redirects. * A valid SSL certificate exist for each domain for which you wish to enable secure redirects. * You own the domains for which you wish to enable secure redirects. ### Return whether shared SSL certificate exists (deprecated) - [GET /SSL/check_shared_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/check_shared_cert.md): This function checks whether a shared SSL certificate is associated with the account. ## SNI Email Settings SSL Certificates / SNI Email Settings ### Disable SNI mail services for domain - [GET /SSL/disable_mail_sni](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/disable_mail_sni.md): This function disables SNI mail services on the specified domains. Mail SNI is enabled. * After you change the SNI status, you run UAPI's function. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. ### Enable SNI mail services for domain - [GET /SSL/enable_mail_sni](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/enable_mail_sni.md): This function enables SNI mail services on the specified domains. Mail SNI is enabled. * Mail SNI is compatible with Webmail and will function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. When you disable the , , , , roles, the system this function. ### Return whether mail SNI is enabled - [GET /SSL/is_mail_sni_supported](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/is_mail_sni_supported.md): This function checks whether the sslinstall feature is enabled. Mail SNI is always enabled. * Mail SNI is compatible with Webmail and will function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI will fail and make no changes. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return whether Apache web server supports mail SNI - [GET /SSL/is_sni_supported](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/is_sni_supported.md): This function checks whether the Apache web server supports SNI. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Return status of domain's SNI mail services - [GET /SSL/mail_sni_status](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/mail_sni_status.md): This function retrieves the status of the domain's SNI mail services. Mail SNI is compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. Mail SNI is always enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. ### Start SNI configuration files rebuild - [GET /SSL/rebuild_mail_sni_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/sni-email-settings/rebuild_mail_sni_config.md): This function rebuilds the SNI configuration files. * You run this function after you change the SNI status through the UAPI's or functions. * Mail SNI is enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes. * Functions that disable Mail SNI will fail and make no changes. When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_, _Webmail_, _Web Server_ roles, the system this function. ## SSL Certificate Management SSL Certificates / SSL Certificate Management ### Delete SSL certificate - [GET /SSL/delete_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_cert.md): This function deletes an SSL certificate. * When you call this function, you include the or the parameter. * This function deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Delete certificate signing request - [GET /SSL/delete_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_csr.md): This function deletes a certificate signing request (CSR). * When you call this function, you include the or the parameter. * To delete a private key, use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Delete private key - [GET /SSL/delete_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/delete_key.md): This function deletes a private key. * When you call this function, you include the or the parameter. * To delete a certificate signing request (CSR), use the UAPI function instead. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Create self-signed SSL certificate - [GET /SSL/generate_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/generate_cert.md): This function generates a self-signed SSL certificate. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Create certificate signing request - [GET /SSL/generate_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/generate_csr.md): This function generates a certificate signing request (CSR). This function a valid key in the account's directory. You can generate a key with UAPI's function. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and WebServer roles, the system this function. ### Create private key - [GET /SSL/generate_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/ssl-generate_key.md): This function generates a private key. * You call both the and parameters in a single call. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Install SSL certificate - [GET /SSL/install_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/install_ssl.md): This function installs an SSL certificate. Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our Call UAPI's SSL::install_ssl Function in Custom Code documentation. When you disable the , , , , and roles, the system this function. ### Update SSL certificate's friendly name - [GET /SSL/set_cert_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_cert_friendly_name.md): This function changes a certificate's friendly name. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update certificate signing request's friendly name - [GET /SSL/set_csr_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_csr_friendly_name.md): This function changes a certificate signing request's (CSR) friendly name. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update private key's friendly name - [GET /SSL/set_key_friendly_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_key_friendly_name.md): This function changes a key's friendly name. * You call either the or parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Update SSL website for dedicated IP address - [GET /SSL/set_primary_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/set_primary_ssl.md): This function sets a new primary SSL website for a dedicated IP address. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Export SSL certificate - [GET /SSL/show_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_cert.md): This function retrieves a certificate. When you call this parameter, you include either the or the parameter. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Export certificate signing request - [GET /SSL/show_csr](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_csr.md): This function retrieves a certificate signing request (CSR). When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. When you call this function, you include either the or the parameter. ### Export private key - [GET /SSL/show_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/show_key.md): This function retrieves a private key. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ### Import SSL certificate - [POST /SSL/upload_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/upload_cert.md): This function uploads a certificate. * Due to the limited field length of HTTP GET method calls, you use the HTTP POST method. For this reason, you use a cPanel or Webmail session URL to call this function. * When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system this function. ### Import private key - [POST /SSL/upload_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/ssl-certificate-management/upload_key.md): This function uploads a private key. Due to the limited field length of HTTP GET method calls, you use the HTTP POST method. For this reason, you use a cPanel or Webmail session URL to call this function. When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, Web Server roles, the system this function. ## DCV The DCV module for UAPI. ### Verify domain ownership via DNS - [POST /DCV/check_domains_via_dns](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/check_domains_via_dns.md): This function checks whether the account's domains can pass Domain Control Validation (DCV) via a DNS request. ### Verify domain ownership via HTTP - [GET /DCV/check_domains_via_http](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/check_domains_via_http.md): This function checks whether the account's domains can pass Domain Control Validation (DCV) via an HTTP request. ### Verify domain ownership (deprecated) - [GET /DCV/ensure_domains_can_pass_dcv](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/ensure_domains_can_pass_dcv.md): This function indicates whether the account's domains can pass a Domain Control Validation (DCV) check. We deprecated this function. Use UAPI's function. ## Verify Domain Ownership SSL Certificates / Verify Domain Ownership ### Verify domain ownership via DNS - [POST /DCV/check_domains_via_dns](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/check_domains_via_dns.md): This function checks whether the account's domains can pass Domain Control Validation (DCV) via a DNS request. ### Verify domain ownership via HTTP - [GET /DCV/check_domains_via_http](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/check_domains_via_http.md): This function checks whether the account's domains can pass Domain Control Validation (DCV) via an HTTP request. ### Verify domain ownership (deprecated) - [GET /DCV/ensure_domains_can_pass_dcv](https://api.docs.cpanel.net/specifications/cpanel.openapi/verify-domain-ownership/ensure_domains_can_pass_dcv.md): This function indicates whether the account's domains can pass a Domain Control Validation (DCV) check. We deprecated this function. Use UAPI's function. ## Stats The Stats module for UAPI. ### Return bandwidth statistics for all domains - [GET /Stats/get_bandwidth](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/get_bandwidth.md): This function retrieves a list of bandwidth records for the domains on a cPanel account. This function also returns the bandwidth use of a distributed cPanel account. This function requires the _Bandwidth Stats_ feature. To enable this feature, use WHM's _Feature Manager_ interface (_WHM >> Home >> Packages >> Feature Manager_). ### Return specified domain access log - [GET /Stats/get_site_errors](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/get_site_errors.md): This function returns entries from a domain's error log. ### Return Analog statistics for all domains - [GET /Stats/list_sites](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/list_sites.md): This function displays the Analog statistics for the domains on a cPanel account. ### Return Analog statistics for specified domain - [GET /Stats/list_stats_by_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/list_stats_by_domain.md): This function returns a domain's Analog statistics. ## Domain Statistics Statistics / Domain Statistics ### Return bandwidth statistics for all domains - [GET /Stats/get_bandwidth](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/get_bandwidth.md): This function retrieves a list of bandwidth records for the domains on a cPanel account. This function also returns the bandwidth use of a distributed cPanel account. This function requires the _Bandwidth Stats_ feature. To enable this feature, use WHM's _Feature Manager_ interface (_WHM >> Home >> Packages >> Feature Manager_). ### Return specified domain access log - [GET /Stats/get_site_errors](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/get_site_errors.md): This function returns entries from a domain's error log. ### Return Analog statistics for all domains - [GET /Stats/list_sites](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/list_sites.md): This function displays the Analog statistics for the domains on a cPanel account. ### Return Analog statistics for specified domain - [GET /Stats/list_stats_by_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domain-statistics/list_stats_by_domain.md): This function returns a domain's Analog statistics. ## StatsManager The StatsManager module for UAPI. ### Returns weblog analyzers' configuration - [GET /StatsManager/get_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/weblog-settings/stats_manager_get_configuration.md): This function lists the configuration of the web log anayzers for each domain on the cPanel account. When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation. Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return. ### Save current user's weblog analyzers configuration - [POST /StatsManager/save_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/weblog-settings/stats_manager_save_configuration.md): This function saves the users choice about which web log anayzers are enabled for each domain on their cPanel users account. If the log anayzers are controlled by the reseller or root account, the user cannot manage which log analyzers are enabled or disabled. When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation. ## Weblog Settings Statistics / Weblog Settings ### Returns weblog analyzers' configuration - [GET /StatsManager/get_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/weblog-settings/stats_manager_get_configuration.md): This function lists the configuration of the web log anayzers for each domain on the cPanel account. When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation. Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return. ### Save current user's weblog analyzers configuration - [POST /StatsManager/save_configuration](https://api.docs.cpanel.net/specifications/cpanel.openapi/weblog-settings/stats_manager_save_configuration.md): This function saves the users choice about which web log anayzers are enabled for each domain on their cPanel users account. If the log anayzers are controlled by the reseller or root account, the user cannot manage which log analyzers are enabled or disabled. When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation. ## UserData The UserData module for cPanel UAPI. ### Return scoped userdata mapping - [GET /UserData/get_scoped_userdata](https://api.docs.cpanel.net/specifications/cpanel.openapi/userdata/get_scoped_userdata.md): This function returns all userdata key/value pairs for a given scope. ### Set scoped userdata key/value - [GET /UserData/set_scoped_userdata](https://api.docs.cpanel.net/specifications/cpanel.openapi/userdata/set_scoped_userdata.md): This function sets (creates or updates) a userdata key/value pair within a specified scope and returns the full updated mapping for that scope. ## EA4 The EA4 module for UAPI. ### Get EA4 configuration recommendations - [GET /get_recommendations](https://api.docs.cpanel.net/specifications/cpanel.openapi/ea4/get_recommendations.md): This function retrieves a list of EasyApache 4 (EA4) configuration recommendations. ## PHP PHP recommendations ### Get custom PHP recommendations. - [GET /get_php_recommendations](https://api.docs.cpanel.net/specifications/cpanel.openapi/php/ea4::get_php_recommendations.md): This function returns a list of recommended PHP versions. ## PassengerApps The PassengerApps module for UAPI. ### Disable Passenger application - [GET /PassengerApps/disable_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/disable_application.md): This function disables a Passenger application on an account. When you disable the Web Server role, the system this function. ### Update Passenger application settings - [GET /PassengerApps/edit_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/edit_application.md): This function edits a Passenger application for an account. : When you disable the Web Server role, the system this function. ### Enable Passenger application - [GET /PassengerApps/enable_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/enable_application.md): This function enables a Passenger application and generates the Apache configuration on an account. When you disable the Web Server role, the system this function. ### Install Passenger application dependencies - [GET /PassengerApps/ensure_deps](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/ensure_deps.md): This function installs the dependencies for a Passenger application. : This function starts the installation process. This may take a long time to complete. : When you disable the Web Server role, the system this function. ### Return Passenger applications - [GET /PassengerApps/list_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/list_applications.md): This function lists an account’s Passenger applications. When you disable the Web Server role, the system this function. ### Register Passenger application - [GET /PassengerApps/register_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/register_application.md): This function registers a Passenger application for an account. : * This function registers an application. It does create the application. You create an application you register the application. For an example of how to do this, read our How to Create Ruby Web Applications documentation. * When you disable the Web Server role, the system this function. ### Unregister Passenger application - [GET /PassengerApps/unregister_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/unregister_application.md): This function unregisters a Passenger application on an account. * This function unregisters an application. It does delete the application. You manually delete the application from your system. * When you disable the Web Server role, the system this function. ## Application Manager Web Server Management / Application Manager ### Disable Passenger application - [GET /PassengerApps/disable_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/disable_application.md): This function disables a Passenger application on an account. When you disable the Web Server role, the system this function. ### Update Passenger application settings - [GET /PassengerApps/edit_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/edit_application.md): This function edits a Passenger application for an account. : When you disable the Web Server role, the system this function. ### Enable Passenger application - [GET /PassengerApps/enable_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/enable_application.md): This function enables a Passenger application and generates the Apache configuration on an account. When you disable the Web Server role, the system this function. ### Install Passenger application dependencies - [GET /PassengerApps/ensure_deps](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/ensure_deps.md): This function installs the dependencies for a Passenger application. : This function starts the installation process. This may take a long time to complete. : When you disable the Web Server role, the system this function. ### Return Passenger applications - [GET /PassengerApps/list_applications](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/list_applications.md): This function lists an account’s Passenger applications. When you disable the Web Server role, the system this function. ### Register Passenger application - [GET /PassengerApps/register_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/register_application.md): This function registers a Passenger application for an account. : * This function registers an application. It does create the application. You create an application you register the application. For an example of how to do this, read our How to Create Ruby Web Applications documentation. * When you disable the Web Server role, the system this function. ### Unregister Passenger application - [GET /PassengerApps/unregister_application](https://api.docs.cpanel.net/specifications/cpanel.openapi/application-manager/unregister_application.md): This function unregisters a Passenger application on an account. * This function unregisters an application. It does delete the application. You manually delete the application from your system. * When you disable the Web Server role, the system this function. ## ModSecurity The ModSecurity module for UAPI. ### Disable ModSecurity for all domains - [GET /ModSecurity/disable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/disable_all_domains.md): This function disables ModSecurity™ on a cPanel account's domains. When you disable the WebServer role, the system this function. ### Disable ModSecurity for selected domains - [GET /ModSecurity/disable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/disable_domains.md): This function disables ModSecurity™ on specified domains. When you disable the WebServer role, the system this function. ### Enable ModSecurity for all domains - [GET /ModSecurity/enable_all_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/enable_all_domains.md): This function enables ModSecurity™ on a cPanel account's domains. When you disable the WebServer role, the system this function ### Enable ModSecurity for selected domains - [GET /ModSecurity/enable_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/enable_domains.md): This function enables ModSecurity™ for specified domains. When you disable the WebServer role, the system this function. ### Return ModSecurity installation status - [GET /ModSecurity/has_modsecurity_installed](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/has_modsecurity_installed.md): This function checks whether ModSecurity™ is installed on a server. When you disable the Web Server role, the system this function. ### Return ModSecurity domains' status - [GET /ModSecurity/list_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/modsecurity/modsecurity-list_domains.md): This function returns ModSecurity's™ status for a cPanel account's domains. When you disable the WebServer role, the system this function. ## NginxCaching The NginxCaching module for UAPI. ### Delete NGINX cache contents. - [GET /NginxCaching/clear_cache](https://api.docs.cpanel.net/specifications/cpanel.openapi/nginxcaching/clear_cache.md): This function clears the user's NGINX cache. - You can use this function if you installed the package. ### Disable the user's NGINX cache - [GET /NginxCaching/disable_cache](https://api.docs.cpanel.net/specifications/cpanel.openapi/nginxcaching/disable_cache.md): This function disables the user's NGINX cache. - You can use this function if you installed the package. ### Enable the user's NGINX cache - [GET /NginxCaching/enable_cache](https://api.docs.cpanel.net/specifications/cpanel.openapi/nginxcaching/enable_cache.md): This function enables the user's NGINX cache. - You can use this function if you installed the package. ### Reset the user's NGINX cache configuration - [GET /NginxCaching/reset_cache_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/nginxcaching/reset_cache_config.md): This function resets the user's NGINX caching configuration. - You can use this function if you installed the package. ## LangPHP The LangPHP module for UAPI. ### Return PHP version's handler - [GET /LangPHP/php_get_domain_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_domain_handler.md): This function returns a PHP version's assigned PHP handler. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation. ### Return domains that shared PHP configuration - [GET /LangPHP/php_get_impacted_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_impacted_domains.md): This function lists domains that obtain their PHP version from a specified PHP configuration. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ### Return installed PHP versions - [GET /LangPHP/php_get_installed_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_installed_versions.md): This function lists the system's PHP versions. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ### Return default PHP version - [GET /LangPHP/php_get_system_default_version](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_system_default_version.md): This function lists the system’s default PHP version. : When you disable the Web Server role, the system this function. ### Return virtual host's PHP version - [GET /LangPHP/php_get_vhost_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_vhost_versions.md): This function returns the PHP version of every virtual host that a reseller controls. You can get the version of a single virtual host by providing an optional name. This document applies to systems that run EasyApache 4. When you disable the Web Server role, the system this function. ### Return basic PHP directives - [GET /LangPHP/php_ini_get_user_basic_directives](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_basic_directives.md): This function lists a virtual host's basic PHP directives. The Basic Mode section of cPanel's MultiPHP INI Editor interface (Home >> Software >> MultiPHP INI Editor) also lists these directives. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Return virtual host's php.ini content - [GET /LangPHP/php_ini_get_user_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_content.md): This function returns the contents of a virtual host's  file. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Return php.ini file paths - [GET /LangPHP/php_ini_get_user_paths](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_paths.md): This function lists the file paths for the user's home directory and virtual host document roots. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Update basic PHP directives - [GET /LangPHP/php_ini_set_user_basic_directives](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_set_user_basic_directives.md): This function sets the values of any basic PHP directive. The section of cPanel's interface () lists these directives. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the Web Server role, the system this function. ### Update virtual host's php.ini content - [GET /LangPHP/php_ini_set_user_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_set_user_content.md): This function changes the contents of a virtual host's file. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Update virtual host's PHP version - [GET /LangPHP/php_set_vhost_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_set_vhost_versions.md): This function sets a virtual host's PHP version. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ## PHP Settings Web Server Management / PHP Settings ### Return PHP version's handler - [GET /LangPHP/php_get_domain_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_domain_handler.md): This function returns a PHP version's assigned PHP handler. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation. ### Return domains that shared PHP configuration - [GET /LangPHP/php_get_impacted_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_impacted_domains.md): This function lists domains that obtain their PHP version from a specified PHP configuration. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ### Return installed PHP versions - [GET /LangPHP/php_get_installed_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_installed_versions.md): This function lists the system's PHP versions. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ### Return default PHP version - [GET /LangPHP/php_get_system_default_version](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_system_default_version.md): This function lists the system’s default PHP version. : When you disable the Web Server role, the system this function. ### Return virtual host's PHP version - [GET /LangPHP/php_get_vhost_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_get_vhost_versions.md): This function returns the PHP version of every virtual host that a reseller controls. You can get the version of a single virtual host by providing an optional name. This document applies to systems that run EasyApache 4. When you disable the Web Server role, the system this function. ### Return basic PHP directives - [GET /LangPHP/php_ini_get_user_basic_directives](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_basic_directives.md): This function lists a virtual host's basic PHP directives. The Basic Mode section of cPanel's MultiPHP INI Editor interface (Home >> Software >> MultiPHP INI Editor) also lists these directives. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Return virtual host's php.ini content - [GET /LangPHP/php_ini_get_user_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_content.md): This function returns the contents of a virtual host's  file. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Return php.ini file paths - [GET /LangPHP/php_ini_get_user_paths](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_get_user_paths.md): This function lists the file paths for the user's home directory and virtual host document roots. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Update basic PHP directives - [GET /LangPHP/php_ini_set_user_basic_directives](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_set_user_basic_directives.md): This function sets the values of any basic PHP directive. The section of cPanel's interface () lists these directives. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the Web Server role, the system this function. ### Update virtual host's php.ini content - [GET /LangPHP/php_ini_set_user_content](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_ini_set_user_content.md): This function changes the contents of a virtual host's file. This document applies to systems that run EasyApache 4 with MultiPHP enabled. When you disable the WebServer role, the system this function. ### Update virtual host's PHP version - [GET /LangPHP/php_set_vhost_versions](https://api.docs.cpanel.net/specifications/cpanel.openapi/php-settings/php_set_vhost_versions.md): This function sets a virtual host's PHP version. This document applies to systems that run EasyApache 4. When you disable the WebServer role, the system this function. ## Handler Management Website Configuration / Handler Management ### Add web server MIME type handler - [GET /Mime/add_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/add_handler.md): This function creates an Apache MIME type handler for a file extension. When you disable the Web Server role, the system this function. ### Remove web server MIME type handler - [GET /Mime/delete_handler](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/delete_handler.md): This function deletes an Apache MIME type handler. When you disable the WebServer role, the system this function. ### Return web server's MIME handlers - [GET /Mime/list_handlers](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/list_handlers.md): This function lists all of Apache's MIME handlers. When you disable the WebServer role, the system this function. ### Return redirect information - [GET /Mime/redirect_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/handler-management/redirect_info.md): This function retrieves redirect information for a URL or . When you disable the Web Server role, the system this function. ## LogManager The LogManager module for UAPI. ### Retrieve cPanel account's log archival settings - [GET /LogManager/get_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/get_settings.md): This function retrieves the account's log archival settings. ### Return cPanel account's archive files list - [GET /LogManager/list_archives](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/list_archives.md): This function returns a list of the user's archive files. ### Save cPanel account's log archive settings - [GET /LogManager/set_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/set_settings.md): This function saves the account's log archive settings. You pass either the or the parameter. ## Logs Website Configuration / Logs ### Retrieve cPanel account's log archival settings - [GET /LogManager/get_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/get_settings.md): This function retrieves the account's log archival settings. ### Return cPanel account's archive files list - [GET /LogManager/list_archives](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/list_archives.md): This function returns a list of the user's archive files. ### Save cPanel account's log archive settings - [GET /LogManager/set_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/logs/set_settings.md): This function saves the account's log archive settings. You pass either the or the parameter. ## Mime Type Management Website Configuration / Mime Type Management ### Add MIME type to web server - [GET /Mime/add_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/add_mime.md): This function adds a MIME type to Apache. When you disable the Web Server role, the system this function. ### Remove MIME type from web server - [GET /Mime/delete_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/delete_mime.md): This function removes a MIME type from Apache. When you disable the WebServer role, the system this function. ### Return web server's MIME types - [GET /Mime/list_mime](https://api.docs.cpanel.net/specifications/cpanel.openapi/mime-type-management/list_mime.md): This function lists all of Apache's MIME types. This function does list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays custom MIME types. When you disable the Web Server role, the system this function. ## WordPressSite The WordPressSite module for UAPI. ### Return WordPress site information - [GET /WordPressSite/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-information/wordpresssite::retrieve.md): This function retrieves the installation status and detailed information of the WordPress site for cPanel user's primary domain. ### Install WordPress site - [GET /WordPressSite/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-installation/wordpresssite::create.md): This function installs a WordPress site for cPanel user's primary domain. ## Site Information Website Configuration / Site Information ### Return WordPress site information - [GET /WordPressSite/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-information/wordpresssite::retrieve.md): This function retrieves the installation status and detailed information of the WordPress site for cPanel user's primary domain. ## Site Installation Website Configuration / Site Installation ### Install WordPress site - [GET /WordPressSite/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-installation/wordpresssite::create.md): This function installs a WordPress site for cPanel user's primary domain. ## SiteTemplates The SiteTemplates module for UAPI. ### Return available Site Publisher templates - [GET /SiteTemplates/list_site_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/list_site_templates.md): This function lists available templates for cPanel's Site Publisher feature. * If you call this function as the or user, the function lists the user's templates. * If you call this function as a reseller, the function lists the user's templates the reseller's templates. * If you call this function as a cPanel user, the function's output depends on the account's owner: * If the user owns the account, the function only lists the user's templates. * If a reseller owns the account, the function lists the user's templates that reseller's templates. The template directory's location depends on whether the user or a reseller owns the template: * — The user's templates. * — A reseller's templates, where represents the reseller's username. * — cPanel-provided templates. When you disable the Web Server role, the system this function. ### Return Site Publisher websites' information - [GET /SiteTemplates/list_user_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/list_user_settings.md): This function lists information for the cPanel account's Site Publisher websites. To retrieve the list of Site Publisher website information, the function queries the file in each domain's document root. For more information, read our Guide to Site Publisher Templates documentation. When you disable the Web Server role, the system this function. ### Add Site Publisher website - [GET /SiteTemplates/publish](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/publish.md): This function publishes a Site Publisher website. * This function uses the script to publish the Site Publisher website. * This function creates the file in the specified directory. * This file contains the user-entered data for the Site Publisher website and uses permissions. * For more information, read our Guide to Site Publisher Templates documentation. * When users publish a Site Publisher website, the system first creates a backup tarball of the target directory's contents in the directory within the user's home directory. * When users publish a Site Publisher website, the system logs template information and the target directory to the file. * The template directory's location depends on whether the user or a reseller owns the template: * — The user's templates. * — A reseller's templates, where represents the reseller's username. * — cPanel-provided templates. When you disable the _Web Server_ role, the system this function. ## Site Publisher Management Website Configuration / Site Publisher Management ### Return available Site Publisher templates - [GET /SiteTemplates/list_site_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/list_site_templates.md): This function lists available templates for cPanel's Site Publisher feature. * If you call this function as the or user, the function lists the user's templates. * If you call this function as a reseller, the function lists the user's templates the reseller's templates. * If you call this function as a cPanel user, the function's output depends on the account's owner: * If the user owns the account, the function only lists the user's templates. * If a reseller owns the account, the function lists the user's templates that reseller's templates. The template directory's location depends on whether the user or a reseller owns the template: * — The user's templates. * — A reseller's templates, where represents the reseller's username. * — cPanel-provided templates. When you disable the Web Server role, the system this function. ### Return Site Publisher websites' information - [GET /SiteTemplates/list_user_settings](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/list_user_settings.md): This function lists information for the cPanel account's Site Publisher websites. To retrieve the list of Site Publisher website information, the function queries the file in each domain's document root. For more information, read our Guide to Site Publisher Templates documentation. When you disable the Web Server role, the system this function. ### Add Site Publisher website - [GET /SiteTemplates/publish](https://api.docs.cpanel.net/specifications/cpanel.openapi/site-publisher-management/publish.md): This function publishes a Site Publisher website. * This function uses the script to publish the Site Publisher website. * This function creates the file in the specified directory. * This file contains the user-entered data for the Site Publisher website and uses permissions. * For more information, read our Guide to Site Publisher Templates documentation. * When users publish a Site Publisher website, the system first creates a backup tarball of the target directory's contents in the directory within the user's home directory. * When users publish a Site Publisher website, the system logs template information and the target directory to the file. * The template directory's location depends on whether the user or a reseller owns the template: * — The user's templates. * — A reseller's templates, where represents the reseller's username. * — cPanel-provided templates. When you disable the _Web Server_ role, the system this function. ## Sitejet The Sitejet module for UAPI. ### Add an existing Sitejet API token. - [GET /Sitejet/add_api_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/add_sitejet_api_token.md): This function adds an existing Sitejet API token to a cPanel user. You can create a Sitejet API token with the function. ### Return Domain Availability - [GET /Sitejet/can_create_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/can_create_domains.md): This function returns whether a cPanel account can create new subdomains or addon domains. Creating a new addon domain is dependent on the creation of subdomains. If the cPanel account has reached its limit for subdomains, you cannot create a new addon domain, even if the limit for addon domains has not been reached. ### Generate a Sitejet API key. - [GET /Sitejet/create_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/create_sitejet_account.md): This function creates a Sitejet API token for a cPanel account. ### Create a restore point. - [GET /Sitejet/create_restore_point](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/create_restore_point.md): This function creates a restore point for a domain's document root and removes the domain's files. ### Create Sitejet domain ID - [GET /Sitejet/create_website](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/create_sitejet_website.md): This function creates a Sitejet ID for the specified domain. A unique Sitejet ID is assigned to each domain on the cPanel account. ### Return Sitejet domains - [GET /Sitejet/get_all_user_sitejet_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/get_all_user_sitejet_info.md): This function returns the Sitejet domains' information for the cPanel account. ### Return Sitejet API token - [GET /Sitejet/get_api_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/get_sitejet_api_token.md): This function returns the cPanel account's Sitejet API token. ### Return Sitejet preview URL - [GET /Sitejet/get_preview_url](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/get_sitejet_preview_url.md): This function returns a Sitejet website's preview URL. ### Return Sitejet SSO URL - [GET /Sitejet/get_sso_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/get_sitejet_sso_link.md): This function returns a Sitejet website's SSO URL. ### Restore a domain from the restore point. - [GET /Sitejet/restore_document_root](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/restore_document_root.md): This function reverts a document root to the restore point. ### Publish Sitejet domain - [GET /Sitejet/start_publish](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/start_publish_sitejet.md): This function publishes a domain's Sitejet website. ### Return Sitejet templates (deprecated) - [GET /Sitejet/get_templates](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/get_sitejet_templates.md): This function fetches the list of available Sitejet templates. ### Update Sitejet template (deprecated) - [GET /Sitejet/set_template](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitejet/set_sitejet_template.md): This function sets a Sitejet website's template.