Last modified January 15, 2025

manageTag

This function lets you manage the accounts tags.
Parameters
Parameter name Type Description Possible values Example
action String REQUIRED Flag to either create or modify the tag. create/modify action=create
_id String The tag ID. REQUIRED when modifying the tag.   _id=6126745fb3086938ff643643
type boolean The tag type. REQUIRED when creating the tag. 1 type=1
name boolean The tag name. REQUIRED when creating the tag.   name=example1
color boolean The tag color. REQUIRED when creating the tag. Hexadecimal color value: #RRGGBB color=#7e2572

Returns standard API Response data.

Example Call JETAPI

jetbackup5api -F manageTag -D "action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR}" jetbackup5api -F manageTag -D "action=create&name={$NAME}&color={$COLOR}&type=1"
success: 1 message: Tag Created/Updated Successfully system: version: 5.3.14.4 version_panel: 5.3.14.4 tier: RELEASE type: cPanel retry_ms: 0 disableui: dr: agreement_panel: agreement: licenseIssue: data: _id: 67758a1170af6de0e006a8d2 name: example1 type: 1 color: #7e2572 owner: 675233ebeecc0e19bb0f5412 owner_name: root

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR} https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=create&name={$NAME}&color={$COLOR}&type=1