event manager

Get event rules

Returns an array with one or more event rules

get/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
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/eventrules/get.ts
A function with typed inputs. Its response is checked against the schema.

offsetinteger

limitinteger

The maximum number of items to return. Max value is 500, default is 100

order'ASC' | 'DESC'

Example:ASC

Ordering rules by name. Default ASC

successful operation

idinteger

namestring

unique name

status0 | 1

status:

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:

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