Permissions
managePermissions
This function allows you to create/modify the Permissions Object of a specified user. (Default: Manage Global Permissions)
More Info
Parameters
| Parameter name |
Type |
Description |
Possible Values |
Example |
|---|
| username |
String |
Username of the acount you wish to change permissions. |
|
username=acct001 |
|---|
| permissions |
List [] |
The permissions Key/Value pair you will be updating. |
For a list of all permissions indexes and possible values, please visit Permissions Object below. |
permissions[0]=1&permissions[2]=2 |
|---|
Example Call JETAPI
jetbackup5api -F managePermissions -D "username={$USERNAME}&permissions[0]=1&permissions[2]=2"
success: 1
message: Permissions updated successfully.
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=managePermissions&username={$USERNAME}&permissions[0]=1&permissions[2]=2
getPermissions
This function returns the Permissions Object of the specific user selected. (Default: Return Global Permissions)
More Info
Parameters
| Parameter name |
Type |
Description |
Possible Values |
Example |
|---|
| username |
String |
Username of the acount you wish to change permissions. |
|
username=acct001 |
|---|
Example Call JETAPI
jetbackup5api -F getPermissions -D "username={$USERNAME}
success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
permissions:
0: 1
1: 0
2: 2
3: 2
4: 2
5: 2
6: 2
7: 2
8: 2
9: 2
10: 2
11: 2
20: 2
19: 2
22: 2
12: 2
21: 2
13: 2
14: 2
15: 2
16: 2
17: 2
18: 2
23: 2
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getPermissions&username={$USERNAME}
resetPermissions
This function resets the permissions of a specific user. (Default: Reset Global Permissions)
More Info
Parameters
| Parameter name |
Type |
Description |
Possible Values |
Example |
|---|
| username |
String |
Username of the acount you wish to reset permissions. |
|
username=acct001 |
|---|
Example Call JETAPI
jetbackup5api -F resetPermissions -D "username={$USERNAME}"
success: 1
message: Permissions reset successfully
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=resetPermissions&username={$USERNAME}
listPermissions
This function lists all permission settings of the current logged in user.
More Info
Returns
| Parameter name |
Type |
Description |
Possible Values |
Example |
|---|
| account |
String |
The Object ID of the current user. |
|
oid: 606dbe8b90f1b17d0569b833 |
|---|
| permissions |
List [] |
List of all the current permissions settings for the user. |
For a full list of all the permissions settings please check Permissions Object below. |
|
|---|
Example Call JETAPI
jetbackup5api -F listPermissions
success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
account:
oid: 65075382d49adbd1660f06d2
permissions:
0: 1
1: 1
2: 1
3: 1
4: 1
5: 1
6: 1
7: 1
8: 1
9: 1
10: 1
11: 1
20: 1
19: 1
22: 1
12: 1
21: 1
13: 1
14: 1
15: 1
16: 1
17: 1
18: 1
23: 1
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listPermissions
- To view available listing parameters, please visit List Parameters.
- API List calls have a default limit of 100 items.
Parameter Dictionary
Permissions Object
| Permission |
Index |
|---|
| Has All Privileges |
0 |
|---|
| Can Manage Accounts |
1 |
|---|
| Can Restore Backups |
2 |
|---|
| Can Download Backups |
3 |
|---|
| Can Manage Full Backups |
4 |
|---|
| Can Manage File Backups |
5 |
|---|
| Can Manage Cron Job Backups |
6 |
|---|
| Can Manage Email Account Backups |
7 |
|---|
| Can Manage Database Backups |
8 |
|---|
| Can Manage SSL Certificate Backups |
9 |
|---|
| Can Manage DNS Zone Backups |
10 |
|---|
| Can Manage Configuration Backups |
11 |
|---|
| Can Manage Backup Jobs |
12 |
|---|
| Can Manage Destinations |
13 |
|---|
| Can Manage Hooks |
14 |
|---|
| Can Manage Permissions |
15 |
|---|
| Can View Logs |
16 |
|---|
| Can Manage Logs |
17 |
|---|
| Can View Alerts |
18 |
|---|
| Can Manage Directory Backups |
19 |
|---|
| Can Manage FTP Account Backups |
20 |
|---|
Possible Values
| Permission Value |
Integer Value |
|---|
| No |
0 |
|---|
| Yes |
1 |
|---|
| Inherit |
2 |
|---|