---
title: "Get filesystem events"
method: GET
path: "/events/fs"
tags: ["events"]
---

# Get filesystem events

`GET /events/fs`

Returns an array with one or more filesystem events applying the specified filters. This API is only available if you configure an "eventsearcher" plugin

## Query parameters

- `start_timestamp` integer
- `end_timestamp` integer
- `actions` FsEventAction[]
- `username` string
- `ip` string
- `ssh_cmd` string
- `fs_provider` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Filesystem providers: * `0` - Local filesystem * `1` - S3 Compatible Object Storage * `2` - Google Cloud Storage * `3` - Azure Blob Storage * `4` - Local filesystem encrypted * `5` - SFTP * `6` - HTTP filesystem
- `bucket` string
- `endpoint` string
- `protocols` EventProtocols[]
- `statuses` FsEventStatus[]
- `instance_ids` string[]
- `from_id` string
- `role` string
- `csv_export` boolean
- `limit` integer
- `order` 'ASC' | 'DESC'

## Response `200`

successful operation

- FsEvent[]
  - `id` string
  - `timestamp` integer — unix timestamp in nanoseconds
  - `action` 'download' | 'upload' | 'first-upload' | 'first-download' | 'delete' | 'rename' | 'mkdir' | 'rmdir' | 'ssh_cmd'
  - `username` string
  - `fs_path` string
  - `fs_target_path` string
  - `virtual_path` string
  - `virtual_target_path` string
  - `ssh_cmd` string
  - `file_size` integer
  - `elapsed` integer — elapsed time as milliseconds
  - `status` 1 | 2 | 3 — Event status: * `1` - no error * `2` - generic error * `3` - quota exceeded error
  - `protocol` 'SSH' | 'SFTP' | 'SCP' | 'FTP' | 'DAV' | 'HTTP' | 'HTTPShare' | 'DataRetention' | 'EventAction' | 'OIDC' — Protocols: * `SSH` - SSH commands * `SFTP` - SFTP protocol * `SCP` - SCP protocol * `FTP` - plain FTP and FTPES/FTPS * `DAV` - WebDAV * `HTTP` - WebClient/REST API * `HTTPShare` - the event is generated in a public share * `DataRetention` - the event is generated by a data retention check * `EventAction` - the event is generated by an EventManager action * `OIDC` - OpenID Connect
  - `ip` string
  - `session_id` string
  - `fs_provider` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Filesystem providers: * `0` - Local filesystem * `1` - S3 Compatible Object Storage * `2` - Google Cloud Storage * `3` - Azure Blob Storage * `4` - Local filesystem encrypted * `5` - SFTP * `6` - HTTP filesystem
  - `bucket` string
  - `endpoint` string
  - `open_flags` string
  - `role` string
  - `instance_id` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `default` — Unexpected Error

---

[API](https://skmtc.net/kanton-bern/apis/sftpgo.md) · [All operations](https://skmtc.net/kanton-bern/apis/sftpgo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kanton-bern/sftpgo/revisions/d8d616a479b0/schema)