---
title: "Get alarm receiver"
method: GET
path: "/api/v1/alarm/receiver/receivers/{name}"
tags: ["Alarm"]
---

# Get alarm receiver

`GET /api/v1/alarm/receiver/receivers/{name}`

Get alarm receiver, query by receiver name.

## Path parameters

- `name` string, required

## Response `200`

OK

- object
  - `data` ReceiverReceiver, required
    - `config` string, required
    - `name` string, required
    - `type` 'discord' | 'email' | 'pagerduty' | 'slack' | 'webhook' | 'opsgenie' | 'wechat' | 'pushover' | 'victorops' | 'sns' | 'telegram' | 'webex' | 'msteams', 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/receiver/receivers/:name/get.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)