NOTICE: JetBackup For Linux is in ALPHA testing stage. Please handle with caution. Any information on this document is subject to change as we continue to develop and make changes.

manageHook

Description

With this function, you create/modify hook.

Parameters

Parameter name Type Description Possible values Example
_id String Required on action modify
The ID of the hook.
  5b3219e1d5ac5e453a7cb842
action String Required
The action you want to perform.
  • create
  • modify
 
name String Required on action create
The name of the hook.
   
positiontype Integer When you want to run the process, pre/post action.
  • Pre - 1
  • Post - 2
 
position Integer The hook type you want.
  • Backup - 1
  • Restore - 2
  • Download - 3
  • Daily Cron - 4
 
list[] List
List of Backup Jobs/Clone Jobs/Restore Types/Download Types/Destinations to execute when the hook is triggered.
List of Strings
   
script String Required on action create
The hook script/hook script path.
   
disabled Boolean Whether the hook is disabled.    

Returns

This API call returns hook object.
To view the parameters that returned click on Hook Object

Example