– Hooks

Jb5: manageHook

Mon, 01 Jan 0001 00:00:00 +0000

**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`
_id	String	REQUIRED on action modify. The ID of the Hook.		`_id=5f890a19e55cf262863522f2`
name	String	REQUIRED on action create. The name you will like to give your hook.		`name=exampleHook`
script	String	REQUIRED on action create. Path to the script file used for your hook. Must begin with /		`script=/PATH/TO/SCRIPT`
position_type	Integer	REQUIRED on action create. When the hook should run.	1 - pre 2 - post	`position_type=2`
position	Integer	REQUIRED on action create. The type of Hook you wish to run.	1 - Backup 2 - Restore 3 - Restore 4 - Download 5 - Reindex 8 - Backup Account 9 - Clone 10 - Clone Account	`position=1`
data_list	List []	List of data to pass to hook depending on position_type.	Backup - List of Backup Job IDs Restore - List of boolean value for Accounts Backup Download - List of boolean value for Accounts Backup Type Reindex - List of Destination IDs Backup Account - List of Backup Job IDs
disabled	Boolean	Boolean for is the Hook is disabled.	1 - true 0 - false	`disabled=1`

Example Call JETAPI

jetbackup5api -F manageHook -D "action=create&name=hookexample&script=/PATH/TO/SCRIPT&position_type=1&position=1"

jetbackup5api -F manageHook -D "action=modify&_id=6509273a7cc0fb810207f612&name=hookexample&position_type=1&position=1"

success: 1
message: Hook 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: 6509273a7cc0fb810207f612
  name: hookexample
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  position_type: 1
  position: 1
  data_list:
  script: /PATH/TO/SCRIPT
  disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageHook&action=create&name=examplehook&script=/PATH/TO/SCRIPT&position_type=1&position=1

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageHook&action=modify&_id=6509273a7cc0fb810207f612&name=hookexample&position_type=2&position=4

Jb5: listHooks

Mon, 01 Jan 0001 00:00:00 +0000

**Returns**
Parameter name	Type	Description	Possible Values	Example
hooks	List []	List of all Hooks Objects.
total	Integer	Total number of Hooks Objects.

Example Call JETAPI

jetbackup5api -F listHooks

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:
  hooks:
        0:
          _id: 6509273a7cc0fb810207f612
          name: hookexample
          owner: 65075382d49adbd1660f06d2
          owner_name: root
          position_type: 2
          position: 4
          data_list:
          script: /PATH/TO/SCRIPT
          disabled:
        1:
          _id: 650927f3e0dd674404058392
          name: hookexample2
          owner: 65075382d49adbd1660f06d2
          owner_name: root
          position_type: 1
          position: 1
          data_list:
          script: /PATH/TO/SCRIPT
          disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listHooks

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

Jb5: getHook

Mon, 01 Jan 0001 00:00:00 +0000

**Returns**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Hook ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F getHook -D "_id={$HOOK_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: 650927f3e0dd674404058392
  name: hookexample2
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  position_type: 1
  position: 1
  data_list:
  script: /PATH/TO/SCRIPT
  disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getHook&_id={$HOOK_ID}

Jb5: deleteHook

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Hook ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F deleteHook -D "_id={$HOOK_ID}"

success: 1
message: Hook 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=deleteHook&_id={$HOOK_ID}