Delete alert by id

delete/v1/organizations/{organizationId}/{environment}/alerts/{alertId}

Page View

The Alerts category contains endpoints to review or manage traffic alert rules, which monitor your integrations for healthy traffic. There are two types of traffic alert rules: No Traffic or Error Threshold.

We recommend using No Traffic alert rules if you want to know if traffic is actually flowing like it should in a given environment. This type of alert rule triggers a notification if a specified data flow hasn't had any logs reach a terminal state (i.e., Succeeded, Filtered, or Failed) in a designated amount of time (i.e., as little as 15 minutes up to 24 hours). If a log is pending, it doesn't count as completed traffic, so pending logs could be a condition of triggering this alert. But also keep in mind that since failed logs count as completed traffic, this type of alert rule doesn't necessarily help you track errors.

We recommend using Error Threshold rules if you want to address traffic errors in a given environment. This type of alert rule triggers a notification if X number of logs have reached a terminal state of Failed and will no longer be retried within a given period of time (i.e., as little as 15 minutes up to 24 hours).

You can retrieve a specific alert or a list of existing traffic alert rules or a specific alert rule, as well as create, update, or delete a traffic alert rule.

Delete alert by id

This endpoint allows you to delete an existing traffic alert rule for a specific environment within a Redox dashboard organization. You must use the correct alert identifier to delete the traffic alert rule.

To delete an alert, you must be an organization owner or the creator of the original traffic alert rule.

Request parameters and payload

Path Parameters

organizationId
required, string
Displays the unique identifier of the Redox dashboard organization where the traffic alert rule is applied.
environment
required, string
Identifies the specific environment that the traffic alert rule is operating in.
alertId
required, string
Displays the unique identifier of the traffic alert rule. This identifier can't be modified once the alert is created.

Select example

cURL request example

1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/{environment}/alerts/{alertId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "alert with id x deleted"
7
  }
8
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
payload
object
- message
  string

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.