Mute/Unmute

API Check Mute/Unmute

What does Mute/Unmute mean?

The Mute/Unmute toggle allows you to control whether alerts are sent for an API Check. When an API Check is muted, it will still run based on the schedule or on demand when clicking the "Run Now" button, but no alerts will be sent. This feature is useful when you need to monitor the API without being notified of its status changes.

How to Mute an API Check

  1. Locate the API Check: Find the API Check you want to mute from the list of API Checks.
  2. Toggle to Mute: Click the toggle switch to change the status from UNMUTED to MUTED.
  3. Save Changes: Ensure you save any changes if required.

When an API Check is muted:

  • The check will still run based on the configured schedule or on demand.
  • No notifications will be sent to any of the alert channels if the API Check was degraded, failed, or recovered.

Mute API Check

How to Unmute an API Check

  1. Locate the API Check: Find the API Check you want to unmute from the list of API Checks.
  2. Toggle to Unmute: Click the toggle switch to change the status from MUTED to UNMUTED.
  3. Save Changes: Ensure you save any changes if required.

When an API Check is unmuted:

  • The check will run based on the configured schedule or on demand.
  • Notifications will be sent to the configured alert channels if the API Check is degraded, failed, or recovered.

Practical Uses of Mute/Unmute

  • Maintenance Windows: Mute checks during scheduled maintenance to avoid unnecessary alerts.
  • Testing and Development: Mute checks while testing new features or during development to focus on critical alerts only.
  • Investigation Periods: Mute checks while investigating persistent issues to prevent alert fatigue.

Visual Indicators

In the list of API Checks:

  • Muted Checks: Displayed with a muted icon or indicator to differentiate from unmuted checks.
  • Unmuted Checks: Displayed normally with their current status and last run results.

By using the Mute/Unmute feature, you can manage your alert notifications more effectively, ensuring that you only receive notifications when they are most needed.