event manager

Find event rules by name

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

get/eventrules/{name}

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/eventrules/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

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

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
            }
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.