v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB

event manager

Find event actions by name

Returns the event action with the given name if it exists.

get/eventactions/{name}

Query parameters

confidential_datainteger

If set to 1 confidential data will not be hidden. This means that the response will contain the key and additional data for secrets. If a master key is not set or an external KMS is used, the data returned are enough to get the secrets in cleartext. Ignored if the * permission is not granted.

Response

successful operation

idinteger

namestring

unique name

descriptionstring

optional description

type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15

Supported event action types:

1 - HTTP
2 - Command
3 - Email
4 - Backup
5 - User quota reset
6 - Folder quota reset
7 - Transfer quota reset
8 - Data retention check
9 - Filesystem
11 - Password expiration check
12 - User expiration check
13 - Identity Provider account check
14 - User inactivity check
15 - Rotate log file

rulesstring[]

list of event rules names associated with this action

Example response

{
  "options": {
    "http_config": {
      "endpoint": "https://example.com"
    },
    "retention_config": {
      "folders": [
        {
          "path": "/",
          "retention": 24
        }
      ]
    }
  }
}