本文へスキップ

エラー

すべてのエラーは、以下の表から最も具体的で適切なHTTPレスポンス・コードを返します：

リターンコード​

コードエラー説明
400悪いリクエストクライアントから不正なリクエストを受信した。これはAPIが返す最も一般的なレスポンスである。
401無許可権限がなく、要求されたリソースにアクセスできません。
403禁止要求されたリソースにアクセスする権限がありません。
404見つかりません要求されたリソースが見つかりません。後で利用可能になるかもしれません
405許可されない方法要求されたリソースに対して、サポートされていないHTTPメソッドが使用されました。
406受け入れられないクライアントが要求したAcceptまたはAccept-Encodingタイプが利用できない。
409紛争既存のリソースと競合するため、リクエストを完了できません。
410なくなった要求されたリソースはもう利用できません。
411必要な長さ要求されたリソースは、クライアントからContent-Lengthが提供されることを期待する。
413リクエスト・エンティティが大きすぎるクライアントが提供したリクエスト・ボディが大きすぎるため、リソースがその処理を拒否した。
415サポートされていないメディアタイプContent-Typeが正しくない（または指定されていない）。
422処理不能なエンティティリクエストは不正ではなく、メディアタイプも許容できるが、リソースはリクエストを処理できない。
429リクエストが多すぎるレートの上限に達しました。詳しくはレート制限の項をご覧ください。
500内部サーバーエラー予期しない内部サーバーエラーにより、サーバーはリクエストを処理できませんでした。
501未実施要求されたリソースが実装されていない
503サービス利用不可要求されたサービスは一時的に利用できません

標準回答フォーマット​

すべてのエラーは、codeとmessageの2つのフィールドを持つ標準的なレスポンスボディを持つ。もっと多くのフィールドを使うこともできるが、それはオプションである。

例​

これは、エラーのリターンボディの最も単純な形であり、クライアントは、これらのフィールドがすべてのエラーに存在することを信頼することができる。

エラー応答 - 例 1 (ベースライン)​


{
        "code": 429,
        "message": "You have exceeded your number of requests. Please try again later"
}

以下の例では、標準のフィールドに加えて、この特定のリクエストに関連するエ ラーがある。

エラー応答 - 例 2 (より複雑)​


{
        "code": 422,
        "message": "Unprocessable entity",
        "cause": "Validation failed",
        "errors": [
            {
                "resource": "Issue",
                "field": "title",
                "code": "missing_field"
            },
            ...
        ]
}