通知グループ

通知グループの登録

POST /api/v0/notification-groups

APIキーに必要な権限

  • Read
  • Write

入力

KEY TYPE DESCRIPTION
name string 通知グループの名称
notificationLevel string 通知レベル ("all" または "critical")
childNotificationGroupIds array[string] 通知先の通知グループのIDの配列
childChannelIds array[string] 通知先の通知チャンネルのIDの配列
monitors array[monitor] [optional] 通知対象の監視ルールの配列
services array[service] [optional] 通知対象のサービスの配列

monitor は以下のキーを持つオブジェクトです。

KEY TYPE DESCRIPTION
id string 監視ルールのID
skipDefault boolean trueの場合、指定の通知グループにのみに通知する

service は以下のキーを持つオブジェクトです。

KEY TYPE DESCRIPTION
name string サービスの名称

入力例

{
  "name": "Example notification group",
  "notificationLevel": "all",
  "childNotificationGroupIds": [],
  "childChannelIds": [
    "2vh7AZ21abc"
  ],
  "monitors": [
    {
      "id": "2qtozU21abc",
      "skipDefault": false
    }
  ],
  "services": [
    {
      "name": "Example-Service-1"
    },
    {
      "name": "Example-Service-2"
    }
  ]
}

応答

入力にidが付与されて返却されます。

失敗時

STATUS CODE DESCRIPTION
400 入力が受け付けられないフォーマットだったとき
400 作成に失敗したとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

通知グループの一覧取得

GET /api/v0/notification-groups

APIキーに必要な権限

  • Read

応答

{
  "notificationGroups": [<notification-group>, <notification-group>, ...]
}

<notification-group> は登録APIの応答と同じ形です。

通知グループの更新

PUT /api/v0/notification-groups/<notificationGroupId&gt

APIキーに必要な権限

  • Read
  • Write

入力

登録APIの入力と同じオブジェクトです。

応答

登録APIの応答と同じオブジェクトです。

失敗時

STATUS CODE DESCRIPTION
400 入力が受け付けられないフォーマットだったとき
400 デフォルト通知グループの名前を変更しようとしたとき
400 更新に失敗したとき
404 指定された通知グループが存在しない時
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

通知グループの削除

オーガニゼーションのデフォルト通知グループは削除できません。

DELETE /api/v0/notification-groups/<notificationGroupId&gt

APIキーに必要な権限

  • Read
  • Write

応答

削除前の通知グループが返却されます。

失敗時

STATUS CODE DESCRIPTION
400 指定された通知グループがデフォルト通知グループのとき
400 削除に失敗したとき
404 指定された通知グループが存在しない時
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合