Sign in

v1

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

Add event rule

Adds a new event rule

post/eventrules

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.

Request body

idinteger
namestring

unique name

status0 | 1

status:

  • 0 disabled
  • 1 enabled
descriptionstring

optional description

created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in millisecond

trigger1 | 2 | 3 | 4 | 5 | 6 | 7

Supported event trigger types:

  • 1 - Filesystem event
  • 2 - Provider event
  • 3 - Schedule
  • 4 - IP blocked
  • 5 - Certificate renewal
  • 6 - On demand, like schedule but executed on demand
  • 7 - Identity provider login

Response

successful operation

idinteger
namestring

unique name

status0 | 1

status:

  • 0 disabled
  • 1 enabled
descriptionstring

optional description

created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in millisecond

trigger1 | 2 | 3 | 4 | 5 | 6 | 7

Supported event trigger types:

  • 1 - Filesystem event
  • 2 - Provider event
  • 3 - Schedule
  • 4 - IP blocked
  • 5 - Certificate renewal
  • 6 - On demand, like schedule but executed on demand
  • 7 - Identity provider login

Example response

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