Account Filters

manageAccountFilter

This function allows you to create/modify the Account Filter Object.

Parameters

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 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.	N/A	`name=Account Filter 1`
condition	Boolean	REQUIRED on action create. The Boolean value to include or exclude chosen fields.	1/2 (include/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.	N/A	`_id=5f864533cde674169f42ffe2`

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

listAccountFilters

This function lists all Account Filter Objects.

More Info

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.

getAccountFilter

This function prints the objects data given its Account Filter ID.

More Info

Parameters

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}

deleteAccountFilter

This function allows you to delete the object given its Account Filter ID.

More Info

Parameters

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}

listAccountFilterGroups

This function lists all Account Filter Group Objects.

More Info

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.

getAccountFilterGroup

This function prints the objects data given its Account Filter Group ID.

More Info

Parameters

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}

Parameter Dictionary

Account Filter Object

Parameter name

Type

Description

Possible Values

Example

_id

String

The Account Filter ID.

N/A

{
  "_id": "5b28f9f4d5ac5e5ed5049f82"
}

group_id

String

The Account Filter Group ID associated to Backup Jobs.

N/A

{
  "group_id": "5b6a87abd5ac5e655e2018d3"
}

type

Integer (Binary Left Shift)

The type of Account Filter.

Accounts Filter	2
Resellers Filter	4
Suspension Filter	8
Disk Space Usage Filter	16
Inodes Usage Filter	32
Packages Filter	64
Characters Range Filter Usage	128
Regular Expression Filter	256
Account Tags Filter	512
Encryption Filter	1024

{
  "type": 2
}

name

String

The Account Filter name.

N/A

{
  "name": "Test Account Filter"
}

owner

String

The Account Filter Owner's ID

N/A

{
  "owner": "6070a5a3fae2cf5881160c03"
}

owner_name

String

The Account Filter Owner's name.

N/A

{
  "owner_name": "root"
}

count

Integer

The Number of Backup Jobs which the Account Filter is assigned to.

N/A

{
  "count": 1
}

condition

Integer

Whether you want to exclude/include the account in the list.

Include	1
Exclude	2

{
  "condition": 2
}

list

List[] of Strings

List of Filter Type specific objects assigned to the Account Filter. (Only for Filter Types 2 | 4 | 64 | 512)

Type 2	List of Accounts
Type 4	List of Resellers
Type 64	List of Packages
Type 512	List of Packages

{
  "list": [
    "testacct1",
    "testacct2"
  ]
}

usage

Integer

The Usage Limit for the Filter Type specific parameter assigned to the Account Filter. (Only for Filter Types 16 | 32)

Type 16	Disk Usage Limit in Bytes
Type 32	Inode Usage Limit

{
  "usage": 4096
}

rangestart

String

The starting character for the range you want to filter by. (Only for Filter Type 128)

0-9_a-z

{
  "rangestart": "0-9_a-z"
}

rangeend

String

The ending character for the range you want to filter by. (Only for Filter Type 128)

0-9_a-z

{
  "rangeend": "0-9_a-z"
}

regex

String

The regular expression you want to filter by. (Only for Filter Types 128 | 256*)

/^[0-9_a-z]/i

{
  "regex": "/^[acct01]/i"
}

JETAPI Documentation

On This Page:

Account Filters

manageAccountFilter

listAccountFilters

getAccountFilter

deleteAccountFilter

listAccountFilterGroups

getAccountFilterGroup

Parameter Dictionary

Account Filter Object

On This Page: