Last modified October 31, 2024

getHook

This function prints the objects data given its Hook Object ID.
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}