---
title: "Mute an alert or some of its groups"
method: POST
path: "/api/v2/{org_id}/alerts/{alert_id}/mute"
tags: ["Alerts"]
---

# Mute an alert or some of its groups

`POST /api/v2/{org_id}/alerts/{alert_id}/mute`

## Request

- Base URL: `https://api.openobserve.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openobserve.ai/api/v2/{org_id}/alerts/{alert_id}/mute`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/v2/:org_id/alerts/:alert_id/mute/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a one-time downtime that targets only this alert: until it clears (ended by the alert's clear, 24 hours at most), for 1 to 1440 minutes, or until an instant. `group_keys` mutes only those groups of a multi-alert; `all_groups` or no keys mutes the whole alert. Filed in `folder_id`, else the default downtimes folder. Allowed for admins and editors (alert edit access with OpenFGA on) and for members of the team of an open on-call response for the alert or its incident. Enterprise only.

## Path parameters

- `org_id` string, required
- `alert_id` string, required

## Query parameters

- `folder` string

## Request body

- AlertMuteRequest: `POST /v2/{org}/alerts/{alert_id}/mute`: exactly one of `until_clear`, `minutes` and `ends_at`.
  - `all_groups` boolean
  - `ends_at` integer, nullable
  - `firing_started_at` integer, nullable
  - `folder_id` string, nullable
  - `group_keys` string[], nullable
  - `minutes` integer, nullable
  - `reason` string, nullable
  - `until_clear` boolean

## Response `201`

Muted

- AlertMuteResponse
  - `alert_groups` AlertGroupRef[], nullable
    - `alert_id` string, required
    - `group_key` string
    - `group_labels` object, nullable: Captured at mute time because `group_key` is a hash the UI cannot show.
  - `downtime_id` string, required
  - `end_on_clear` EndOnClear: "Until it clears": `group_key` null ends the downtime when no group of the alert is firing.
    - `alert_id` string, required
    - `group_key` string, nullable
  - `ends_at` integer, required
  - `pages` MutedPage[]: The open on-call pages of the alert's problem the mute snoozed, or tried to.
    - `refused` string, nullable
    - `response_id` string, required
    - `snoozed_until` integer, nullable
    - `team` string, required
  - `version` integer, required

## Other responses

- `400`: Invalid request
- `403`: Refused, with who is on call and who can act; or not supported
- `404`: NotFound
- `409`: Already muted, or the org's downtime cap is reached

---

[API](https://skmtc.dev/openobserve/apis/openobserve-api-http.md) - [All operations](https://skmtc.dev/openobserve/apis/openobserve-api-http/llms.txt) - [OpenAPI document](https://skmtc.dev/openobserve/apis/openobserve-api-http/revisions/0529b8a10252?raw)