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 returns whether the in-product survey banner should display for the current user and the survey link.
Notes:
- The function selects a link template based on whether the authenticated user is a webmail user or a cPanel/Team user.
- A
displayvalue of0means you should not render the banner UI.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/InProductSurvey/get_in_product_survey_url
- A server running cPanel.
https://cpanel-server.tld:2083/execute/InProductSurvey/get_in_product_survey_url
- 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/InProductSurvey/get_in_product_survey_urlResponse
application/json
{ "apiversion": 3, "func": "get_in_product_survey_url", "module": "InProductSurvey", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }