RFC 9457 - Problem Details for HTTP APIs
Internet Engineering Task Force (IETF)
Request for Comments: 9457
Obsoletes: RFC 7807
Category: Standards Track
Authors:
- M. Nottingham
- E. Wilde
- S. Dalal
Date: July 2023
Abstract
This document defines a "problem detail" to carry machine-readable details of errors in HTTP response content to avoid the need to define new error response formats for HTTP APIs.
This document obsoletes RFC 7807.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9457.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.
Contents
- 1. Introduction
- 2. Requirements Language
- 3. The Problem Details JSON Object
- 4. Defining New Problem Types
- 5. Security Considerations
- 6. IANA Considerations
- 7. References
- Appendix A. JSON Schema for HTTP Problems
- Appendix B. HTTP Problems and XML
- Appendix C. Using Problem Details with Other Formats
- Appendix D. Changes from RFC 7807
- Acknowledgements
- Authors' Addresses
Related Resources
- Official RFC: RFC 9457 (TXT)
- DataTracker: RFC 9457
- Obsoletes: RFC 7807