Last modified November 7, 2024

manageQueuePriority

This function lets you create and manage Queue Priority Groups.

Queue Priority Groups

Parameter name Type Description Possible values Example
_id String REQUIRED on action modify. The ID of the queue priority group.   _id=60898b7f2ba85218685acfd9
action String REQUIRED The action you want to perform.
  • create
  • modify
  
name String REQUIRED on action create. Queue priority group name.   name=VIP
tags List [] List of Account Tag IDs that is associated to the queue priority group.   tags[]=608b077566c0e32488215a62
backup_priority Integer REQUIRED on action create. The backup priority level of the queue priority group.    
restore_priority Integer REQUIRED on action create. The restore priority level of the queue priority group.    
download_priority Integer REQUIRED on action create. The download priority level of the queue priority group.    
default Boolean Sets the priority group as the default priority.
  • 1 (true)
  • empty/null (false)
  

Example Call JETAPI

jetbackup5api -F manageQueuePriority -D "action=create&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}"

jetbackup5api -F manageQueuePriority -D "_id={$QUEUE_PRIORITY_GROUP_ID}&action=modify&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}"
success: 1
message: Queue Priority Created/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:
  _id: 6508feba65219ded7d044202
  name: test
  tags:
    0: 6508f84ca80e83597707ca92
    1: 6508f9127d8b1bca210caec2
  backup_priority: 40
  clone_priority: 30
  restore_priority: 20
  download_priority: 10
  default:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageQueuePriority&action=create&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageQueuePriority&_id={$QUEUE_PRIORITY_GROUP_ID}&action=modify&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}