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 retrieves a list of available WordPress® site backups of a single site.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressBackup/get_available_backups
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressBackup/get_available_backups
- 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/WordPressBackup/get_available_backups?site=example.com%2Fwordpress'Response
application/json
{ "apiversion": 3, "func": "get_available_backups", "module": "WordPressBackup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function checks for an active WordPress® site backup.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressBackup/is_running
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressBackup/is_running
- 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/WordPressBackup/is_running?site=example.com%0A%0Aexample.com%2Fwordpress'Response
application/json
{ "apiversion": 3, "func": "is_running", "module": "WordPressBackup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function starts a single WordPress® site backup.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressBackup/start
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressBackup/start
- 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/WordPressBackup/start?site=example.com'Response
application/json
{ "apiversion": 3, "func": "start", "module": "WordPressBackup", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }