event manager
Add event rule
Adds a new event rule
post/eventrules
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
- TypeScriptA 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.
Request body
Response
successful operation
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.