チェック監視

チェック監視結果の投稿

チェック監視の結果を Mackerel に送信します。監視結果はホストに紐付きます。

POST /api/v0/monitoring/checks/report

チェック監視項目を追加する の実装に使われています。 エージェントは設定されたチェック監視の名前の一覧を ホスト情報の更新 の API に定期的に送信しており、その時に一覧に含まれないチェック監視は Mackerel から削除されます。 同じ名前/ホストで監視時刻が新しいものが既に投稿されていた場合、投稿は無視されます。

APIキーに必要な権限

  • Read
  • Write

入力

{
  "reports": [ <report>, <report>, … ]
}

<report> : 以下のキーをもつオブジェクトです。

KEY TYPE DESCRIPTION
source source 下記参照。
name string 監視名。
status string 監視結果ステータス。"OK""CRITICAL""WARNING""UNKNOWN" のいずれかです。
message string 監視結果ステータスに付随する補助的なテキスト, 1024文字以下です。
occurredAt number 監視実行時刻のエポック秒。
notificationInterval number [optional] アラートの再送間隔 (分) 省略した場合は再送されない。10分未満を指定した場合は、10分間隔で再送通知されます。

source : 以下のキーをもつオブジェクトです。

KEY TYPE DESCRIPTION
type string 定数文字列 "host"
hostId string ホストID(ホスト登録時にサーバから与えられるもの)

応答

成功時

{
  "success": true
}

失敗時

STATUS CODE DESCRIPTION
403 必要な権限がないとき
200以外 上記以外のエラー