---
title: "Events list"
method: GET
path: "/v2/storage/events"
tags: ["Events"]
---

# Events list

`GET /v2/storage/events`

## Request

- Base URL: `https://connection.keboola.com`
- URL: `https://connection.keboola.com/v2/storage/events`
- Auth: one of:
  - API key in header `X-StorageApi-Token`
  - API key in header `X-KBC-ManageApiToken`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/keboola/apis/keboola-storage-api/docs/v2/storage/events/get.ts> (a function with typed inputs; its response is checked against the schema)

For admin tokens will endpoint lists all events in the project. For non-admin tokens will list only events created by the token.

Virtually every interaction of the client (an API call) creates an Event. Apart from that, external events may
also be added via an API. Events are stored for a limited time.

Id field is deprecated and will be removed in the future. Please use Uuid instead.

Events can be filtered by various filters:
- `sinceId`, `maxId` - Events newer or older than the passed id or Uuid (id is deprecated and will be removed in the future)
- `component` - Component name
- `configurationId` - Configuration id
- `runId` - Run id
- `q` - Advanced search using a query string. [Query string syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax)

The events pagination uses two parameters:
- `limit` - Number of returned events. The default value: 100
- `offset` - Pagination offset

The branch variant lists events of the given [Development Branch](#tag/Development-Branches); `default` can be used as `branchId`
to emulate the call without a development branch, i.e. `GET /v2/storage/events` is the same as `GET /v2/storage/branch/default/events`.

## Query parameters

- `sinceId` string
- `maxId` string
- `component` string
- `configurationId` string
- `runId` string
- `q` string
- `limit` integer
- `offset` integer
- `sortOrder` 'asc' | 'desc'

## Response `200`

List of events.

- EventResponse[]
  - `uuid` string, required: Event UUID v7 identifier.
  - `event` string, required: Event identifier such as `storage.tableImportDone` or `storage.tableDetail`. External events are named `ext.{component}.{configurationId}`.
  - `component` string, required: Name of the component that logged the event. Events can be logged by the `storage` component or any other registered component.
  - `message` string, required: Human readable description of the event.
  - `description` string, required: Additional description of the event, such as a detailed error description.
  - `type` 'info' | 'success' | 'warn' | 'error', required: Type of the event.
  - `runId` string, nullable, required: Id of the associated job.
  - `created` string, required: When the event was created, ISO 8601 with a `+hhmm` offset; `""` when none was recorded.
  - `configurationId` string, nullable, required: Id of a configuration used by an external component.
  - `objectId` union, required: Id of the target object of the event, e.g. table id for `storage.tableImportDone`. An integer for objects with numeric ids, such as files, workspaces, branches and admins.
    - string
    - integer
  - `objectName` string, required: Name of the target object, e.g. table name for `storage.tableImportDone`.
  - `objectType` string, required: Type of the target object, e.g. `table` for `storage.tableImportDone`.
  - `context` union, required: Details about the origin of the API call that triggered the event; an empty array `[]` when the event has no context.
    - object
      - `remoteAddr` string, nullable
      - `httpReferer` string, nullable
      - `httpUserAgent` string, nullable
      - `httpUserAgentOriginal` string, nullable
      - `authorization` string, nullable
      - `apiVersion` string, nullable
    - unknown[]
      - unknown
  - `params` object, required: Arbitrary parameters associated with the event, e.g. CSV file settings for table import.
  - `results` object, required: Arbitrary results of the event.
  - `performance` object, required: Arbitrary performance metrics associated with the event.
  - `token` object, required: Creator of the event.
    - `id` integer, required: Id of the token.
    - `name` string, nullable, required: Token owner.
  - `idBranch` integer, nullable, required: Id of the branch the event belongs to, including the default branch; `null` when the event is not tied to a branch.
  - `uri` string, required: Event URI.
  - `attachments` EventAttachmentResponse[], required: Files attached to the event, e.g. backups for table import events.
    - `id` integer, required: Id of the attached file.
    - `isSliced` boolean, required: Whether the file is sliced.
    - `uploadType` string, required: Upload type of the file.
    - `isExpired` boolean, required: Whether the file has already expired.
    - `created` string, required: When the file was created, ISO 8601 with a `+hhmm` offset.
    - `name` string, required: File name.
    - `url` string, required: Download URL of the file.
    - `sizeBytes` integer, nullable, required: File size in bytes.

## Other responses

- `400`: Invalid filter parameters, e.g. `limit` out of range, negative `offset` or unknown `sortOrder` (`storage.events.error`).

---

[API](https://skmtc.dev/keboola/apis/keboola-storage-api.md) - [All operations](https://skmtc.dev/keboola/apis/keboola-storage-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keboola/apis/keboola-storage-api/revisions/34b5ceac0317?raw)