– AccountFilters

Jb5: manageAccountFilter

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform	modify/create	`action=create`
type	Integer	REQUIRED/ONLY AVAILABLE on action create. The integer value for Account Filter Type.	Visit Account Filter Types below for all possible values.	`type=2`
name	String	REQUIRED on action create. The name given to your Account Filter for internal use.		`name=Account Filter 1`
condition	Integer	REQUIRED on action create. The Integer value to include or exclude chosen fields.	1 - Include 2 - Exclude	`condition=1`
list	List []	REQUIRED on action create. List of Account Usernames for Account Filter.	Visit listAccounts to find usernames of your accounts.	`list[0]=acct1&list[1]=acct2`
_id	String	REQUIRED on action modify. Account Filter ID is used for when you want to modify any of the Account Filter Object Fields.		`_id=5f864533cde674169f42ffe2`
owner	String	The Account Filter Owner's ID		`owner=670a937d1b620f5bbb0329a2`
usage	Integer	The Usage Limit for the Filter Type specific parameter assigned to the Account Filter. (Only for Filter Types 16 \| 32)	Type 16 - Usage Limit in Bytes Type 32 - Inode Usage Limit	`usage=4096`
range_start	String	The starting character for the range you want to filter by. (Only for Filter Type 128)	0-9_a-z	`range_start=0`
range_end	String	The ending character for the range you want to filter by. (Only for Filter Type 128)	0-9_a-z	`range_end=z`

To view the parameters returned, click on Account Filter Objects

Example Call JETAPI

jetbackup5api -F manageAccountFilter -D \
"action=create&\
type=2&\
name={$FILTER_NAME}&\
condition=1&\
list[0]={$ACCOUNT_NAME}&\
list[1]={$ACCOUNT_NAME}"

success: 1
message: Account Filter Created 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:
_id: 650b6ee8d8c76d2a42271352
group_id: 650b6ee8d8c76d2a42271353
type: 2
name: Account Filter 1
owner: 64f37d695aa01f55661b38f2
owner_name: root
count: 0
condition: 1
list:
        0: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageAccountFilter&action=create&type=2&name=Account Filter 1&condition=1&list[0]=acct1&list[1]=acct2

Jb5: listAccountFilters

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Function call does not require parameters.

Example Call JETAPI

jetbackup5api -F listAccountFilters

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:
filters:
        0:
        _id: 64f37dd63d5cd855603d04f2
        group_id: 64f37dd63d5cd855603d04f3
        type: 2
        name: user
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        count: 1
        condition: 1
        list:
                0: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccountFilters

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: getAccountFilter

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED Account Filter ID of the Account Filter Object you are trying to fetch.	N/A	`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F getAccountFilter -D "_id={$ACCOUNT_FILTER_ID}"

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:
_id: 64f37dd63d5cd855603d04f2
group_id: 64f37dd63d5cd855603d04f3
type: 2
name: user1
owner: 64f37d695aa01f55661b38f2
owner_name: root
count: 1
condition: 1
list:
        0: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getAccountFilter&_id={$ACCOUNT_FILTER_ID}

Jb5: deleteAccountFilter

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED Account Filter ID of the Account Filter Object you are trying to delete.	N/A	`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F deleteAccountFilter -D "_id={$ACCOUNT_FILTER_ID}"

success: 1
message: Account Filter Deleted 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=deleteAccountFilter&_id={$ACCOUNT_FILTER_ID}

Jb5: listAccountFilterGroups

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Function call does not require parameters.

Example Call JETAPI

jetbackup5api -F listAccountFilterGroups

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:
groups:
        0:
        _id: 64f37dd63d5cd855603d04f3
        name: user
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        filters:
                0: 64f37dd63d5cd855603d04f2
        count: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccountFilterGroups

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: getAccountFilterGroups

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED Account Filter Group ID of the Account Filter Group Object you are trying to fetch.	N/A	`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F getAccountFilterGroup -D "_id={$ACCOUNT_FILTER_ID}"

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:
_id: 64f37dd63d5cd855603d04f2
group_id: 64f37dd63d5cd855603d04f3
type: 2
name: user
owner: 64f37d695aa01f55661b38f2
owner_name: root
count: 1
condition: 1
list:
        0: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getAccountFilterGroup&_id={$ACCOUNT_FILTER_ID}