hooks
Hook scripts for specific events.
get /events/hooks
List of all installed hook scripts.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /events/hooks
Install a hook script at a given hook point.
Parameters
body object
Examples
Request Body
{
"event": "PreNetworkConfig",
"scriptId": 42,
"serverIds": [
42
],
"allServers": true
}get /events/scripts
List all script files.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /events/scripts
Create a script file.
Parameters
body object Required
Examples
Request Body
{
"name": "string",
"contents": "string"
}patch /events/hooks/{id}
Install a hook script at a given hook point.
Parameters
id integer path Required
body object Required
Examples
Request Body
{
"event": "PreNetworkConfig",
"scriptId": 42,
"serverIds": [
42
],
"allServers": true
}delete /events/hooks/{id}
Delete a hook event.
Parameters
id integer path Required
Examples
No request body required
get /events/hook-scripts
List all script files with their linked hooks.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /events/hook-scripts
Create a script file and link hooks.
Parameters
body object Required
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"hooks": [
{
"event": "PreNetworkConfig",
"serverIds": [
42
],
"allServers": true
}
],
"contents": "string"
}get /events/scripts/{id}
Get the script file contents.
Parameters
id integer path Required
Responses
default response
default response
string
Examples
No request body required
patch /events/scripts/{id}
Update or rename a script file.
Parameters
id integer path Required
body object Required
Examples
Request Body
{
"name": "string",
"contents": "string"
}delete /events/scripts/{id}
Delete a script file.
Parameters
id integer path Required
Examples
No request body required
post /events/scripts/execute
Run a script immediately.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"args": [
"string"
],
"script": "string",
"servers": [
42
],
"scriptId": 42
}patch /events/hook-scripts/{id}
Update or rename a script file and linked hooks.
Parameters
id integer path Required
body object Required
Examples
Request Body
{
"name": "string",
"hooks": [
{
"event": "PreNetworkConfig",
"serverIds": [
42
],
"allServers": true
}
],
"contents": "string"
}get /events/hooks/hook-points
List of all available hook points.
Responses
default response
default response
array
Array of HookPointInfo objects
Examples
No request body required