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 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.
Note:
NVData keys and values are limited to 128 and 2048 bytes, respectively.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Personalization/get
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Personalization/get
- 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/Personalization/get \
-H 'Content-Type: application/json' \
-d '{
"names": [
"coffee",
"milk"
]
}'Response
application/json
{ "apiversion": 3, "func": "get", "module": "Personalization", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
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.
Note:
NVData keys and values are limited to 128 and 2048 bytes, respectively.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Personalization/set
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Personalization/set
- 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/Personalization/set \
-H 'Content-Type: application/json' \
-d '{
"personalization": {
"coffee": "hot",
"milk": "cold"
}
}'Response
application/json
{ "apiversion": 3, "func": "set", "module": "Personalization", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }