Last modified October 31, 2024

listHooks

This function lists all Hook Objects.
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