Delete alert

delete/v1/alerts/{alertId}

Page View

Alert endpoints allow you 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.

Redox recommendations

We recommend using No Traffic alert rules if you want to make sure traffic is flowing like it should. One alert rule applies to one subscription in a given environment. This type of alert rule triggers a notification if no logs reach a terminal state (i.e., Succeeded, Filtered, or Failed) in a specified amount of time (i.e., as little as 2 hours up to 72 hours). Pending logs don't count as completed traffic, so that could be a condition to trigger this alert. But remember that since failed logs count as completed traffic, this type of alert rule isn't for tracking 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 reach a terminal state of Failed and will no longer be retried within a specified 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

Delete an existing traffic alert rule for a specific environment within a Redox organization. You must use the correct alert ID 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

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/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®.