Account Filters

manageAccountFilter

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

Example Response Data

Successful function returns a complete Account Filter Object

{
  "success": 1,
  "message": "Account Filter Created Successfully",
  "data": {
    "_id": "619f1c63477768734a51bdf2",
    "group_id": "619f1c63477768734a51bdf3",
    "type": 2,
    "name": "Account Filter API",
    "owner": "619e5b3edc8b2c3efb6ed972",
    "owner_name": "root",
    "count": 0,
    "condition": 1,
    "list": [
      "acct001"
    ]
  },
  "system": {
    "version": "5.1.14",
    "version_panel": "5.1.14",
    "tier": "STABLE",
    "type": "cPanel",
    "disableui": false,
    "dr": false,
    "agreement_panel": false,
    "agreement": false,
    "licenseIssue": false
  }
}

listAccountFilters

This function lists all Account Filter Objects.


getAccountFilter

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


deleteAccountFilter

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


listAccountFilterGroups

This function lists all Account Filter Group Objects.


getAccountFilterGroup

This function prints the objects data given its Account Filter Group 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"
}