---
title: "List alerts"
method: POST
path: "/api/v1/alarm/alert/alerts"
tags: ["Alarm"]
---

# List alerts

`POST /api/v1/alarm/alert/alerts`

List alerts, filter with alarm objects, severity, time and keywords.

## Request body

- AlertAlertFilter
  - `endTime` integer
  - `instance` OceanbaseOBInstance
    - `obcluster` string
    - `observer` string
    - `obtenant` string
    - `obzone` string — obzone may exist in labels
    - `type` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer', required
  - `instanceType` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer'
  - `keyword` string
  - `severity` 'critical' | 'warning' | 'caution' | 'info'
  - `startTime` integer

## Response `200`

OK

- object
  - `data` AlertAlert[], required
    - `description` string
    - `endsAt` integer, required
    - `fingerprint` string, required
    - `instance` OceanbaseOBInstance, required
      - `obcluster` string
      - `observer` string
      - `obtenant` string
      - `obzone` string — obzone may exist in labels
      - `type` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer', required
    - `labels` CommonKVPair[]
      - `key` string, required
      - `value` string, required
    - `rule` string, required
    - `severity` 'critical' | 'warning' | 'caution' | 'info', required
    - `startsAt` integer, required
    - `status` AlertStatus, required
      - `inhibitedBy` string[], required
      - `silencedBy` string[], required
      - `state` 'active' | 'unprocessed' | 'suppressed', required
    - `summary` string
    - `updatedAt` integer, required
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2024-04-29** `5e1f25f76011` — 1 info
  - endpoint added
- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/alarm/alert/alerts/post.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)