アラートを作成

新しいアラートを作成します

POST /api/v2/alerts

アラートを作成

cURL

curl --request POST \
  --url https://api.hyperdx.io/api/v2/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": {
    "type": "webhook",
    "webhookId": "65f5e4a3b9e77c001a789012"
  },
  "dashboardId": "65f5e4a3b9e77c001a567890",
  "interval": "1h",
  "message": "Error rate has exceeded 100 in the last hour",
  "name": "Error Spike Alert",
  "source": "tile",
  "threshold": 100,
  "thresholdType": "above",
  "tileId": "65f5e4a3b9e77c001a901234"
}
'

200

{
  "data": {
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "createdAt": "2023-01-01T00:00:00.000Z",
    "dashboard": "65f5e4a3b9e77c001a567890",
    "groupBy": "<string>",
    "id": "65f5e4a3b9e77c001a123456",
    "interval": "15m",
    "message": "Error rate exceeds threshold",
    "name": "High Error Rate",
    "savedSearch": "<string>",
    "silenced": true,
    "source": "tile",
    "state": "inactive",
    "team": "65f5e4a3b9e77c001a345678",
    "threshold": 100,
    "thresholdType": "above",
    "tileId": "65f5e4a3b9e77c001a901234",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

承認

Authorization · string · header · 必須

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

ボディ

application/json

channel · object · 必須

Show child attributes

interval · string · 必須

例:

"1h"

source · enum<string> · 必須

利用可能なオプション: tile, search

例:

"tile"

threshold · number · 必須

例:

100

thresholdType · enum<string> · 必須

利用可能なオプション: above, below

例:

"above"

dashboardId · string

例:

"65f5e4a3b9e77c001a567890"

message · string

例:

"Test Alert Message"

name · string

例:

"Test Alert"

tileId · string

例:

"65f5e4a3b9e77c001a901234"

レスポンス

200

application/json

アラートを正常に作成しました

data · object

Show child attributes