UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Query
The remote server's hostname or IP address.
Example: host=example.com
One of:
A valid hostname.
string(hostname)
A valid hostname.
The directory on the remote server that will store the backup.
Note:
- This value defaults to the remote server account's default login directory.
- Enter the directory relative to the FTP user's login directory. For example, enter
/public_ftpnot/home/username/public_ftp.
Example: directory=/public_ftp
The email address to receive a confirmation email when the backup completes.
Note:
The system does not provide confirmation if you do not pass this parameter.
Default null
Example: email=username@example.com
How to manage the home directory in the backup.
include— Include the home directory in the backup.skip— Omit the home directory from the backup.
Default "include"
Enum"include""skip"
Example: homedir=include
Whether to use the active or passive FTP variant to connect to the remote server. For more information about FTP variants, read our How to Enable FTP Passive Mode documentation.
active— The FTP server responds to the connection attempt and returns a connection request from a different port to the FTP client.passive— The FTP client initiates connection attempts.
Default "active"
Enum"active""passive"
Example: variant=active
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_ftp
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/fullbackup_to_ftp
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_ftp?host=example.com&password=luggage123456&username=username&directory=%2Fpublic_ftp&email=username%40example.com&homedir=include&port=21&variant=active'Response
application/json
{ "apiversion": 3, "func": "fullbackup_to_ftp", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_homedir
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/fullbackup_to_homedir
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_homedir?email=username%40example.com&homedir=include'Response
application/json
{ "apiversion": 3, "func": "fullbackup_to_homedir", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The remote server's hostname or IP address.
Example: host=example.com
One of:
A valid hostname.
string(hostname)
A valid hostname.
The SSH key's name.
Notes:
- To generate a private SSH key, use the UAPI
SSL::generate_keyfunction. - To import an existing SSH key, use the cPanel API 2
SSH::importkeyfunction.
Example: key_name=examplesshkey
The SSH key's password.
Example: key_passphrase=123456luggage
The directory on the remote server that will store the backup.
Note:
This parameter defaults to the remote server account's default login directory.
Example: directory=/user
The email address to receive a confirmation email when the backup completes.
Note:
The system does not provide confirmation if you do not pass this parameter.
Default null
Example: email=username@example.com
How to manage the home directory in the backup.
include— Include the home directory in the backup.skip— Omit the home directory from the backup.
Default "include"
Enum"include""skip"
Example: homedir=include
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_scp_with_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/fullbackup_to_scp_with_key
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/fullbackup_to_scp_with_key?host=example.com&key_name=examplesshkey&key_passphrase=123456luggage&directory=%2Fuser&email=username%40example.com&homedir=include&port=22'Response
application/json
{ "apiversion": 3, "func": "fullbackup_to_scp_with_key", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }