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/
Request
This function restores an account's email filters.
Important:
When the Receive Mail role is disabled, the system also disables this function.
Note:
You must use the backup parameter when you call this function in one of the following formats:
- As part of a
multipart/form-datarequest body to upload and restore a backup file to the server. - As a query parameter to restore an existing file on the server.
Security
BasicAuth
Query Examples:
Bodymultipart/form-dataThe email filter file to restore.
Important:
Only pass this parameter to restore email filter files that already exist on the server.
Note:
To restore multiple email filter files, increment the parameter name. For example: backup-1, backup-2, and backup-3.
backup=backup-1=/home/user/filter_info1.username.yaml.gz backup-2=/home/user/filter_info2.username.yaml.gz backup-3=/home/user/filter_info3.username.yaml.gz
backup=/home/user/filter_info.username.yaml.gz
The maximum number of seconds to try to restore the file.
0- The system will not time out the file restoration.
Default 7200
Example: timeout=3600
The email filter file to upload and restore.
Important:
- Only pass this parameter to upload files that don't already exist on the server.
- You can't pass this parameter on the command line.
Note:
- To upload multiple email filter files, increment the parameter name. For example:
backup-1,backup-2, andbackup-3. - Pass this file in a multipart/form-data structure.
- For more information about this structure, read Mozilla's POST Method documentation.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_email_filters
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/restore_email_filters
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_email_filters?backup=string&timeout=3600&verbose=1' \
-H 'Content-Type: multipart/form-data' \
-F backup=stringResponse
application/json
{ "apiversion": 3, "func": "restore_email_filters", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function restores an account's email forwarders.
Important:
When the Receive Mail role is disabled, the system also disables this function.
Note:
You must use the backup parameter when you call this function in one of the following formats:
- As part of a
multipart/form-datarequest 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.
Security
BasicAuth
Query Examples:
Bodymultipart/form-dataThe email forwarder file to restore.
Important:
Only pass this parameter to restore email forwarder files that already exist on the server.
Note:
To restore multiple email filter files, increment the parameter name. For example: backup-1, backup-2, and backup-3.
backup=backup-1=/home/user/aliases-example1.com.gz backup-2=/home/user/aliases-example2.com.gz backup-3=/home/user/aliases-example3.com.gz
backup=/home/user/aliases-example.com.gz
The maximum number of seconds to try to restore the file.
0- The system will not time out the file restoration.
Default 7200
Example: timeout=3600
The email forwarder file to upload and restore.
Important:
- Only pass this parameter to upload files that don't already exist on the server.
- You can't pass this parameter on the command line.
Note:
To upload multiple email filter files, increment the parameter name. For example: backup-1, backup-2, and backup-3.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_email_forwarders
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/restore_email_forwarders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_email_forwarders?backup=string&timeout=3600&verbose=1' \
-H 'Content-Type: multipart/form-data' \
-F backup=stringResponse
application/json
{ "apiversion": 3, "func": "restore_email_forwarders", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function restores an account's files.
Important:
When the File Storage role is disabled, the system also disables this function.
Note:
You must use the backup parameter when you call this function in one of the following formats:
- As part of a
multipart/form-datarequest 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.
Security
BasicAuth
Query Examples:
Bodymultipart/form-dataThe backup file to restore.
Important:
Only pass this parameter to restore backup files that already exist on the server.
Note:
To restore multiple backup files, increment the parameter name. For example: backup-1, backup-2, and backup-3.
backup=backup-1=/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz backup-2=/home/cpuser/backup-cpuser.tld-9-10-2019_2.tar.gz
backup=/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz
The directory to which to restore the file. The default is the user's home directory.
Example: directory=/home/user/example
The maximum number of seconds to try to restore the file.
0- The system will not time out the file restoration.
Default 172800
Example: timeout=7200
The backup file to upload and restore.
Important:
- Only pass this parameter to upload files that don't already exist on the server.
- You can't pass this parameter on the command line.
Note:
To upload and restore multiple backup files, increment the parameter name. For example: backup-1, backup-2, and backup-3.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_files
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Backup/restore_files
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Backup/restore_files?backup=string&directory=%2Fhome%2Fuser%2Fexample&timeout=7200&verbose=1' \
-H 'Content-Type: multipart/form-data' \
-F backup=stringResponse
application/json
{ "apiversion": 3, "func": "restore_files", "module": "Backup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }