Skip to main content

Alerts - Delete

Endpoint

/i/alert/delete

Overview

Deletes an alert by ID. Non-global-admin users can delete only alerts they created.

Authentication

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions

Requires alerts Update permission.

Request Parameters

ParameterTypeRequiredDescription
alertIDStringYesAlert ID to remove.
app_idStringConditionalRequired for non-global-admin users during update validation.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Response

Success Response

{
"result": "Deleted an alert"
}

Response Fields

FieldTypeDescription
resultStringDeletion result message.

Error Responses

  • 400
{
"result": "Missing parameter \"api_key\" or \"auth_token\""
}
  • 400
{
"result": "Alert to delete not found. Make sure alert exists and you have rights to delete it."
}
  • 401
{
"result": "No app_id provided"
}
  • 401
{
"result": "User does not exist"
}
  • 401
{
"result": "User does not have right"
}
  • 500
{
"result": "Failed to delete an alert"
}
  • 500
{
"result": "Failed to delete an alertMongoServerError: write conflict"
}

Behavior/Processing

Behavior Modes

ModeTriggerProcessing PathResponse Shape
Delete successMatching alert found and removedRemoves alert document and invalidates alert processor cache.Wrapped success message
Not found / no rightsNo matching alert for queryReturns not-found-or-no-rights message.Wrapped error message

Impact on Other Data

  • Invalidates alerts cache so removed alert is not processed in future runs.

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission checksReads member account and access rights for update validation.
countly.appsApp validation/context loadingValidates app_id for non-global-admin update access.
countly.alertsAlert rule persistenceRemoves matching alert document by _id (+ createdBy filter for non-admin users).

Examples

Delete alert

/i/alert/delete?
app_id=6991c75b024cb89cdc04efd2&
api_key=YOUR_API_KEY&
alertID=65f0cbf8bca6b8e8fbf7f901

Limitations

  • For non-global-admin users, delete query includes createdBy=current_user, so IDs for alerts owned by other users are reported as not found.

Last Updated

2026-02-17