event manager

Update event action

Updates an existing event action

put/eventactions/{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/eventactions/:name/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

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 request

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

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any

Changes

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