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 the WordPress Manager plugin's version.
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/WordPressInstanceManager/get_api_version
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/get_api_version
- 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/WordPressInstanceManager/get_api_versionResponse
application/json
{ "apiversion": 3, "func": "get_api_version", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves a WordPress® instance's configuration.
Note:
- You must 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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/get_instance_by_id
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/get_instance_by_id
- 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/WordPressInstanceManager/get_instance_by_id?id=cPanel__Blogs__WordPressX.0.1528208546'Response
application/json
{ "apiversion": 3, "func": "get_instance_by_id", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists an account's WordPress® instances.
Note:
- You must 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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/get_instances
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/get_instances
- 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/WordPressInstanceManager/get_instancesResponse
application/json
{ "apiversion": 3, "func": "get_instances", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }