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/
Query
The Subaccount user's associated domain that the cPanel account owns.
Example: domain=example.com
The Subaccount's password.
Note:
Email, FTP, and Web Disk services use this password.
Example: password=123456luggage
The username for the Subaccount. The username can only contain alphanumeric characters, dots (.), hyphens (-), and underscores (_).
Note:
This value does not include the domain name.
Example: username=example
An alternate email address for the Subaccount's user.
Note:
You must use this parameter if you set the send_invite value to 1.
Default null
Example: alternate_email=user@example.com
The URL path to the user's Subaccount profile photo.
Note:
You must use the HTTPS protocol to prevent mixed content warnings when users view the image from another HTTPS URL.
Warning:
We reserved this parameter for future use. Do not use this parameter.
Default null
Example: avatar_url=https://img.example.com/avatars/example.jpg
A phone number for the Subaccount user that conforms to ITU-T's E.164 standards.
Warning:
We reserved this parameter for future use. Do not use this parameter.
Default null
Example: phone_number=+15551234567
The Subaccount user's first and/or last name.
Default null
Example: real_name=John Doe
Whether to send a reset password email to the Subaccount's alternate email address.
1- Send.0- Do not send.
Default 0
Enum01
Example: send_invite=0
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), allocated to Subaccount's email account.
0orunlimited- The subaccount has unlimited disk space.
This value defaults to the defined system value.
Note:
This value cannot be larger than the system's maximum email quota.
Example: services.email.quota=500
Whether to send client configuration instructions to the account.
1- Send the instructions.0- Do not send the instructions.
Default 0
Enum01
Example: services.email.send_welcome_email=1
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, relative to the cPanel account's home directory.
Note:
- This parameter is required if you enabled the
services.ftp.homedirparameter. - The 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 the Web Disk Digest Authentication.
1- Enabled.0- Disabled.
Note:
- 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.
Default 0
Enum01
Example: services.webdisk.enabledigest=0
The Subaccount's Web Disk home directory, relative to the cPanel account's home directory.
Note:
This parameter is required if you enable the services.webdisk.enabled parameter.
Example: services.webdisk.homedir=/Subaccount
The Subaccount's file permissions for its Web Disk home directory.
ro- Read-only permissions.rw- Read and write permissions.
Note:
The services.webdisk.homedir parameter determines the Subaccount's Web Disk home directory.
Default "rw"
Example: services.webdisk.perms=rw
Whether to set the 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/create_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/create_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/create_user?domain=example.com&password=123456luggage&username=example&alternate_email=user%40example.com&avatar_url=https%3A%2F%2Fimg.example.com%2Favatars%2Fexample.jpg&phone_number=%2B15551234567&real_name=John+Doe&send_invite=0&services.email.enabled=1&services.email.quota=500&services.email.send_welcome_email=1&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": "create_user", "module": "UserManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.
- If one service account uses the same username and domain, the function returns the service account's information.
- If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.
Note:
- A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.
- This function returns only metadata if the specified username and domain do not match any service accounts or hypothetical Subaccounts.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserManager/delete_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/delete_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/delete_user?domain=example.com&username=example'Response
application/json
{ "apiversion": 3, "func": "delete_user", "module": "UserManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
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 } }