Description

This function removes a script hook.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/delete_hook?api.version=1&id=HzEpGvT6QGUYwxuX3hWB8AUq
https://hostname.example.com:2087/cpsess##########/xml-api/delete_hook?api.version=1&id=HzEpGvT6QGUYwxuX3hWB8AUq
whmapi1 delete_hook id=HzEpGvT6QGUYwxuX3hWB8AUq

{
 "metadata": {
    "result": 1,
    "reason": "OK",
    "version": 1,
    "command": "delete_hook"
  }
}
    <metadata>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
        <command>delete_hook</command>
    </metadata>

   

Parameters

ParameterTypeDescriptionPossible valuesExample

id

string

Required

The script hook's ID.

To retrieve a hook's ID, use the list_hooks function.

A valid string.

HzEpGvT6QGUYwxuX3hWB8AUq

Returns

This function only returns metadata.