ログイン
ログイン
Waroom ドキュメント/API (v0)

API (v0)

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

使い方

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

API 一覧

インシデント管理API

メソッドパス概要
GETインシデント一覧取得
GETインシデント詳細取得
PATCHインシデントステータス更新
PATCHインシデント重要度更新
POSTインシデントメトリクス作成・更新
PATCHインシデントラベル更新

ポストモーテム管理API

メソッドパス概要
GETポストモーテム一覧取得
POSTポストモーテム作成
GETポストモーテムテンプレート取得
PATCHポストモーテムテンプレート更新

サービス管理API

メソッドパス概要
GETサービス一覧取得
GETサービスラベル一覧取得
POSTサービスラベル作成
PATCHサービスラベル更新
DELETEサービスラベル削除
GETサービスアーキテクチャコンテキスト取得
PATCHサービスアーキテクチャコンテキスト更新

インシデント管理API

 

POST

新しいインシデントを作成します。
Curl
Request Body
パラメーター説明
パラメーター名必須型説明
service_name✅stringインシデントが発生したサービス名（事前に登録されている必要があります）
title✅stringインシデントのタイトル
severity✅string重要度: , , , ,
experimentalboolean実験的インシデントフラグ（デフォルト: false）
descriptionstringインシデントの詳細説明
is_privatebooleanプライベートインシデントフラグ（デフォルト: false）
Successful Response (201 Created)
Error Responses
422 Unprocessable Entity (バリデーションエラー)
404 Not Found (サービスが存在しない)
400 Bad Request (リクエストパラメーターエラー)
注意事項
  • サービス名: は組織内に存在するサービス名である必要があります
  • 重要度: は指定の値のみ受け付けます
  • ステータス: 作成時は自動的に (検出) に設定されます
  • プライベート機能: は組織でプライベートインシデント機能が有効な場合のみ動作します
  • Slack通知: プライベートインシデント以外の場合、インシデント作成の Slack 通知が送信されます

GET

インシデントの一覧情報を取得します。
 
Curl
Arguments
URLクエリパラメータとして以下を設定できます。
パラメーター名デフォルト概要
per_page501ページあたりのインシデント数
page1何ページ目か
Successful Response
 
Incidents
uuidインシデントの固有ID
titleインシデントのタイトル
severityインシデントの重大度 （UNKNOWN, 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インシデントに設定したカスタムラベル
state_document自動生成されたステートドキュメントのmarkdown
created_atインシデントの起票時刻（ISO 8601)
postmortems関連ポストモーテムの配列
incident_slack_channelIncident に紐づく Slack チャンネル

PATCH

インシデントのステータスを更新します。
Curl
Request Body
Successful Response
Error Response

PATCH

インシデントの重要度を更新します。
Curl
Request Body
Successful Response

POST

インシデントメトリクス（TTD/TTA/TTI/TTF/TTR）を作成・更新します。
Curl
Request Body
Successful Response

PATCH

インシデントのラベルを更新します。
Curl
Request Body
Successful Response

ポストモーテム管理API

GET

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

POST

新しいポストモーテムを作成します。
Curl
Request Body
Successful Response

GET

ポストモーテムテンプレートを取得します。
Curl
Successful Response

PATCH

ポストモーテムテンプレートを更新します。
Curl
Request Body
Successful Response

サービス管理API

GET

サービスの一覧情報を取得します。
Curl
Arguments
URLクエリパラメータとして以下を設定できます。
パラメーター名デフォルト概要
per_page501ページあたりのサービス数
page1何ページ目か
Successful Response

GET

特定のサービスのラベル一覧を取得します。
Curl
Successful Response

POST

特定のサービスに新しいラベルを作成します。
Curl
Request Body
Successful Response

PATCH

特定のサービスのラベルを更新します。
Curl
Request Body
Successful Response

DELETE

特定のサービスのラベルを削除します。
Curl
Successful Response

GET

特定のサービスのアーキテクチャコンテキストを取得します。
Curl
Successful Response

PATCH

特定のサービスのアーキテクチャコンテキストを更新します。
Curl
Request Body
Successful Response

レスポンス形式

エラーレスポンス

全てのエンドポイントで共通のエラーレスポンス形式を使用します。
400 Bad Request
404 Not Found
422 Unprocessable Entity

ページネーション

一覧系のエンドポイントでは以下の形式でページネーション情報を提供します。

認証

全てのエンドポイントでBearerトークンによる認証が必要です。