API キー
Public API を利用するには API キーが必要です。
API キーの作成
Section titled “API キーの作成”- ダッシュボードの「API Keys」メニューを開きます
- キーの名前を入力し、スコープを選択して「Create API Key」をクリック
- 表示されたキーをコピーして安全な場所に保存します
| スコープ | 権限 |
|---|---|
| read | モニター・インシデント・ステータスページの一覧と詳細取得 |
| write | モニターの作成・更新・削除、インシデントの確認 |
API キーの形式
Section titled “API キーの形式”API キーは mk_ プレフィクスに続く 64 文字の 16 進数文字列です。
mk_a1b2c3d4e5f6...API リクエストの Authorization ヘッダーに Bearer トークンとして設定します。
curl -H "Authorization: Bearer mk_your_api_key_here" \ https://api.manako.dev/api/v1/monitorsPublic API エンドポイント
Section titled “Public API エンドポイント”Public API(/api/v1/*)では以下の操作が可能です:
read スコープ:
- モニター一覧の取得・詳細取得
- インシデント一覧の取得
- ステータスページ一覧の取得
write スコープ:
- モニターの作成・更新・削除
- モニターの手動チェック実行
- インシデントの作成・更新・解決・削除(手動インシデント)
- インシデントの確認(acknowledge)
詳細は API リファレンス を参照してください。
- API キーはいつでも無効化(削除)できます
- キーの無効化は即座に反映されます
- 1 チームあたりの API キー作成数には上限があります