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 primary contact email address to set for the team user.
Example: email1=teamuser@example.com
The secondary contact email address to set for the team user.
Example: email2=teamuser@example.com
The reason for expiration.
Example: expire_reason=teamUser gave a two week notice.
Notes about the new team user. This field should not contain private information.
Example: notes=This is a note about teamUser
Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.
1- Create and associate an email subaccount.0- Remove any associated email subaccounts.
Default 0
Enum01
Example: services.email.enabled=1
The maximum amount of disk space, in megabytes (MB), allocated to the team user'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 create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.
1- Create and associate an FTP subaccount.0- Remove any associated FTP subaccounts.
Default 0
Enum01
Example: services.ftp.enabled=1
The team user'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=/Teamusername
Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.
1- Create and associate a Web Disk subaccount.0- Remove any associated Web Disk subaccounts.
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 team user'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=/Teamusername
The team user'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 team user'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
The epoch time the team user account expires on or the offset in days.
set_expire=120days
set_expire=1649948169
One of:
integer
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Team/edit_team_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/edit_team_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/Team/edit_team_user?user=teamUser&add_role=database&email1=teamuser%40example.com&email2=teamuser%40example.com&expire_reason=teamUser+gave+a+two+week+notice.¬es=This+is+a+note+about+teamUser&password=securepassword&remove_role=database&services.email.enabled=1&services.email.quota=500&services.ftp.enabled=1&services.ftp.homedir=%2FTeamusername&services.webdisk.enabled=1&services.webdisk.enabledigest=0&services.webdisk.homedir=%2FTeamusername&services.webdisk.perms=rw&services.webdisk.private=1&set_expire=0&set_role=email'Response
application/json
{ "apiversion": 3, "func": "edit_team_user", "module": "Team", "result": { "data": {}, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Team/get_team_users_with_roles_count
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/get_team_users_with_roles_count
- 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/Team/get_team_users_with_roles_countResponse
application/json
{ "apiversion": 3, "func": "get_team_users_with_roles_count", "module": "Team", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Team/list_team
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/list_team
- 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/Team/list_team?format=array'Response
application/json
{ "apiversion": 3, "func": "list_team", "module": "Team", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }