API (v0)

現在 v0 として試験的に外部 API を公開しています。API はチームプラン以上のプランに契約されていて、ご利用希望をいただいたお客様にご提供しています。 ご利用希望の際は、お問い合わせください。

使い方

以下のように のエンドポイントに対して、リクエストします。 ヘッダーの は、Waroomスタッフより発行されてものに置き換えてください。
 
Curl のリクエスト例

API 一覧

GET

インシデントの一覧情報を取得します。
 
Curl
Arguments
URLクエリパラメータとして以下を設定できます。
パラメーター名デフォルト概要
per_page501ページあたりのインシデント数
page1何ページ目か
Successful Response
 
Incidents
uuidインシデントの固有ID
titleインシデントのタイトル
severityインシデントの重篤度 (INFO, LOW, HIGH, CRITICAL)
statusインシデント対応のステータス (検出, 調査中, 修正中, 復旧済, 完了)
root_causeインシデントの原因のラベル
metricsTTx 系の計算結果 ( 単位: ms)
experimentalテストインシデントかどうか
serviceインシデントに紐づくサービスの情報
labelsインシデントに設定したカスタムラベル
created_atインシデントの起票時刻(ISO 8601)
postmortems関連ポストモーテムの配列
 
Postmortem
uuidポストモーテムの固有ID
titleポストモーテムのタイトル
blobポストモーテムの本文
statusポストモーテムのステータス (下書き: draft, 完了: closed)
 
response_metadata
current_page現在のページ
next_page次のページ
prev_page前のページ
total_pages総ページ数
total_count総インシデント数
 

GET

インシデントの詳細情報をを取得します。
 
Curl
Successful Response
Incident
uuidインシデントの固有ID
titleインシデントのタイトル
severityインシデントの重篤度 (INFO, LOW, HIGH, CRITICAL)
statusインシデント対応のステータス (検出, 調査中, 修正中, 復旧済, 完了)
root_causeインシデントの原因のラベル
metricsTTx 系の計算結果 ( 単位: ms)
serviceインシデントに紐づくサービスの情報
labelsインシデントに設定したカスタムラベル
created_atインシデントの起票時刻(ISO 8601)
postmortems関連ポストモーテムの配列
incident_slack_channelIncident に紐づく Slack チャンネル
 

GET

ポストモーテムの一覧情報を取得します。
 
Curl
Arguments
URLクエリパラメータとして以下を設定できます。
パラメーター名デフォルト概要
per_page501ページあたりのインシデント数
page1何ページ目か
Successful Response
Postmortems
uuidポストモーテムの固有ID
titleポストモーテムのタイトル
blobポストモーテムの本文
statusポストモーテムのステータス (下書き: draft, 完了: closed)
authorポストモーテム作成者の名前
Incidents
Postmortem に紐づくインシデント
uuidインシデントの固有ID
titleインシデントのタイトル
severityインシデントの重篤度 (INFO, LOW, HIGH, CRITICAL)
statusインシデント対応のステータス (検出, 調査中, 修正中, 復旧済, 完了)
root_causeインシデントの原因のラベル
serviceインシデントに紐づくサービスの情報
created_atインシデントの起票時刻(ISO 8601)
response_metadata
current_page現在のページ
next_page次のページ
prev_page前のページ
total_pages総ページ数
total_count総インシデント数