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 removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the Link option in cPanel's User Manager interface (cPanel >> Home >> Preferences >> User Manager).
Note:
You must use at least one of the following parameters:
services.email.dismissservices.ftp.dismissservices.webdisk.dismiss
Security
BasicAuth
Query
The username for the service account.
Note:
This parameter does not include the domain name.
Example: username=example1
Whether to dismiss the merge of the email service account.
1- Dismiss.0- Do not dismiss.
Default 0
Enum01
Example: services.email.dismiss=1
Whether to dismiss the merge of the FTP service account.
1- Dismiss.0- Do not dismiss.
Default 0
Enum01
Example: services.ftp.dismiss=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserManager/dismiss_merge
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/dismiss_merge
- 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/UserManager/dismiss_merge?domain=example.com&username=example1&services.email.dismiss=1&services.ftp.dismiss=1&services.webdisk.dismiss=1'Response
application/json
{ "apiversion": 3, "func": "dismiss_merge", "module": "UserManager", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The Subaccount user's associated domain.
A domain that the cPanel account owns.
Example: domain=example.com
The Subaccount's username.
- Length - 64 characters.
- Characters -
a-z,A-Z,0-9, dot (.), hyphen (-), underscore (_).
Note:
This value does not include the domain name.
Example: username=example
An alternate email address for the Subaccount's user.
Note:
The cPanel account user could use this email address to contact the Subaccount user if their primary email address's domain is unavailable.
Default null
Example: alternate_email=user@example.com
Warning:
We reserved this parameter for future use. Do not use this parameter.
The user's Subaccount profile photo.
Note:
You must use the HTTPS protocol to prevent mixed content warnings when users view the photo from another HTTPS URL.
Default null
Example: avatar_url=https://img.example.com/avatars/example.jpg
The Subaccount's new password.
Note:
The Subaccount uses this password for email, FTP, and Web Disk services.
Example: password=12345luggage
The Subaccount user's phone number.
Warning:
We reserved this parameter for future use. Do not use this parameter.
The number conforms to the ITU-T's E.164-recommended standard for the representation of telephone numbers.
Default null
Example: phone_number=+15551234567
The Subaccount user's name.
- A first name.
- A last name.
- A first name and last name.
- An empty string.
Default null
Example: real_name=John Doe
Whether to grant the Subaccount email access.
1- Can access.0- Cannot access.
Default 0
Enum01
Example: services.email.enabled=1
The maximum amount of disk space, in megabytes (MB), that the subaccount's email account may use.
If you do not declare a value, the system defaults to the defined system value.
Note:
This value cannot be greater than the maximum email quota.
0orunlimited- The subaccount possesses unlimited disk space.
Example: services.email.quota=500
Whether to grant the Subaccount FTP access.
1- Can access.0- Cannot access.
Default 0
Enum01
Example: services.ftp.enabled=1
The Subaccount's FTP home directory.
Note:
This parameter is required if you enable FTP access.
A relative path from the cPanel account's home directory.
Note:
The specified directory must exist.
Example: services.ftp.homedir=/Subaccount
Whether to grant the Subaccount Web Disk access.
1- Can access.0- Cannot access.
Default 0
Enum01
Example: services.webdisk.enabled=1
Whether to enable Web Disk digest authentication.
Notes:
Only enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is only required on servers that use a self-signed certificate for the
cpsrvdandcpdavddaemons.We recommend that you do not use Digest Authentication.
1- Enabled0- Disabled.
Default 0
Enum01
Example: services.webdisk.enabledigest=0
The Subaccount's Web Disk home directory.
Note:
This parameter is required if you enable Web Disk access.
A relative path from the cPanel account's home directory.
Example: services.webdisk.homedir=/Subaccount
Whether to grant write permissions to the Subaccount.
Note:
The services.webdisk.homedir parameter determines the Subaccount's Web Disk home directory.
ro- Read-only permissions.rw- Read and write permissions.
Default "rw"
Enum"ro""rw"
Example: services.webdisk.perms=rw
Whether to set the Web Disk directory's permissions to public or private.
1- Private (0700).0- Public (0755).
Default 0
Enum01
Example: services.webdisk.private=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserManager/edit_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/edit_user
- 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/UserManager/edit_user?domain=example.com&username=example&alternate_email=user%40example.com&avatar_url=https%3A%2F%2Fimg.example.com%2Favatars%2Fexample.jpg&password=12345luggage&phone_number=%2B15551234567&real_name=John+Doe&services.email.enabled=1&services.email.quota=500&services.ftp.enabled=1&services.ftp.homedir=%2FSubaccount&services.webdisk.enabled=1&services.webdisk.enabledigest=0&services.webdisk.homedir=%2FSubaccount&services.webdisk.perms=rw&services.webdisk.private=1&type=sub'Response
application/json
{ "apiversion": 3, "func": "edit_user", "module": "UserManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserManager/list_users
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/list_users
- 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/UserManager/list_users?flat=0'Response
application/json
{ "apiversion": 3, "func": "list_users", "module": "UserManager", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }