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 creates a Dynamic DNS (DDNS) domain.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DynamicDNS/create
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DynamicDNS/create
- 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/DynamicDNS/create?domain=home.example.com&description=Home+network'Response
application/json
{ "apiversion": 3, "func": "create", "module": "DynamicDNS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function deletes an existing Dynamic DNS (DDNS) domain.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DynamicDNS/delete
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DynamicDNS/delete
- 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/DynamicDNS/delete?id=ggiugyxxjwnkmqtwysgmvrurplmafxpq'Response
application/json
{ "apiversion": 3, "func": "delete", "module": "DynamicDNS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists the user’s Dynamic DNS (DDNS) domains.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DynamicDNS/list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DynamicDNS/list
- 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/DynamicDNS/listResponse
application/json
{ "apiversion": 3, "func": "list", "module": "DynamicDNS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }