Skip to main content
PUT
/
api
/
v2
/
alerts
/
{id}
Update Alert
curl --request PUT \
  --url https://api.hyperdx.io/api/v2/alerts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "threshold": 500,
  "interval": "1h",
  "thresholdType": "above",
  "source": "tile",
  "dashboardId": "65f5e4a3b9e77c001a567890",
  "tileId": "65f5e4a3b9e77c001a901234",
  "channel": {
    "type": "webhook",
    "webhookId": "65f5e4a3b9e77c001a789012"
  },
  "name": "Updated Alert Name",
  "message": "Updated threshold and interval"
}
'
{
  "data": {
    "id": "65f5e4a3b9e77c001a123456",
    "name": "High Error Rate",
    "message": "Error rate exceeds threshold",
    "threshold": 100,
    "interval": "15m",
    "thresholdType": "above",
    "source": "tile",
    "state": "inactive",
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "team": "65f5e4a3b9e77c001a345678",
    "tileId": "65f5e4a3b9e77c001a901234",
    "dashboard": "65f5e4a3b9e77c001a567890",
    "savedSearch": "<string>",
    "groupBy": "<string>",
    "silenced": true,
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://private-7c7dfe99-fix-code-feedback-popover-styling.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Alert ID

Body

application/json
​
threshold
number
Example:

500

​
interval
string
Example:

"1h"

​
thresholdType
enum<string>
Available options:
above,
below
Example:

"above"

​
source
enum<string>
Available options:
tile,
search
Example:

"tile"

​
dashboardId
string
Example:

"65f5e4a3b9e77c001a567890"

​
tileId
string
Example:

"65f5e4a3b9e77c001a901234"

​
channel
object
​
name
string
Example:

"Updated Alert Name"

​
message
string
Example:

"Updated message"

Response

Successfully updated alert

​
data
object