Last modified December 28, 2024

addMultiAccountQueueItems

This function lets you Queue Multiple Account Backup Items for restore or download.
Parameter name Type Description Possible values Example
type Integer REQUIRED The Queue Group Type.
  • 2: Restore Queue
  • 4: Download Queue
    		•  type=2
    backup_contains String REQUIRED The Backup Contains value.   backup_contains=511
    filters List [] REQUIRED A list of Filters that determines which Items will be added to the Queue. For detailed descriptions of each filter, see the listAccountsByFilters documentation.
    • date_start (ISO-8601 format)
    • date_end (ISO-8601 format)
    • destination (string)
    • backup_structure (integer): 0 (Any), 1 (Incremental), 2 (Archived), 4 (Compressed)
    • backup_contains (integer)
    • accounts (string)
    • owned_by (string)
    • tags (string)
    • account_status (integer): 0 (Any), 1 (Only Active), 2 (Only Orphan)
    • account_suspended (integer): 0 (Any), 1 (Unsuspended), 2 (Suspended)
    • locked (integer): 0 (Any), 1 (Locked), 2 (Unlocked)
    • encrypted (integer): 0 (Any), 1 (Encrypted), 2 (Unencrypted)
    • show_oldest (boolean): 0 (Sort by Newest), 1 (Sort by Oldest)
    		 filters[date_start]=2022-07-31T17:00:18.484Z&filters[backup_contains]=511&filters[locked]=2& filters[encrypted]=2&filters[account_status]=0&filters[owned_by]=root
    excluded List[] REQUIRED Exclude specific accounts from being added to the queue. Please note: ALL accounts not specifically EXCLUDED will be INCLUDED.   excluded[0]=user1&excluded[1]=user2&excluded[2]=user3
    options List[] REQUIRED List of options you want to execute with the Queue Item(s). This parameter is only available for Restore Queue Type (2). For boolean type options, value is set to false by default.   options[merge]=true&options[owner]=root&options[package]=default

    Response

    This API call returns queue group objects.

    To view the parameters returned by this function, click on Queue Group Object.

    Example Call JETAPI

    jetbackup5api -F addMultiAccountQueueItems -D "type=4&backup_contains=1&filters[listAccountsByFilters]=0&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0&options[allbackups]=0&options[suspend]=0"
    success: 1
message: Selected accounts added to the queue Successfully
system:
  version: 5.3.15.0
  version_panel: 5.3.15.0
  tier: ALPHA
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

    Example Call HTTP

    https://HOST_NAME:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addMultiAccountQueueItems&type=4&backup_contains=1&filters[listAccountsByFilters]=0&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0&options[allbackups]=0&options[suspend]=0
    https://HOST_NAME:2222/CMD_PLUGINS_ADMIN/jetbackup5/index.raw?api=1&function=addMultiAccountQueueItems&type=4&backup_contains=1&filters[listAccountsByFilters]=0&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0&options[allbackups]=0&options[suspend]=0
    https://HOST_NAME:3035/?api=1&function=addMultiAccountQueueItems&type=4&backup_contains=1&filters[listAccountsByFilters]=0&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0&options[allbackups]=0&options[suspend]=0