エラー
公開 REST API のリクエストが失敗した場合、HTTP ステータスコードでエラー種別を判別できます。認証・認可まわりの代表的なエラーは以下のとおりです。
代表的なエラー
| ステータス | 意味 | 主な原因 |
|---|---|---|
400 | Bad Request | リクエストパラメータが不正(必須パラメータ欠落、形式不正な projectId など) |
401 | Unauthorized | X-API-Key ヘッダが未指定、または無効・失効した API キー |
403 | Forbidden | API キーは有効だが、そのエンドポイントが要求する権限が割り当てられていない(または対象プロジェクト外) |
404 | Not Found | 指定したリソースが存在しない |
備考
403 は「キー自体は正しいが権限が足りない」場合に返ります。エンドポイントが要求する権限は権限一覧、および自動生成リファレンスの各エンドポイント詳細(x-required-permission)で確認してください。
エンドポイント固有のレスポンス
各エンドポイントのレスポンスボディ構造や個別のエラー条件は、左サイドバーの自動生成「API リファレンス」を参照してください。