RFC 7807 - Problem Details for HTTP APIs
Status: Obsoleted by RFC 9457
Published: March 2016
Authors: M. Nottingham (Akamai), E. Wilde
Category: Standards Track
ISSN: 2070-1721
Abstract
This document defines a "problem detail" as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs.
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 5741.
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7807.
Copyright Notice
Copyright (c) 2016 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 (http://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 Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
Contents
- 1. Introduction
- 2. Requirements
- 3. The Problem Details JSON Object
- 3.1. Members of a Problem Details Object
- 3.2. Extension Members
- 4. Defining New Problem Types
- 4.1. Example
- 4.2. Predefined Problem Types
- 5. Security Considerations
- 6. IANA Considerations
- 6.1.
application/problem+json - 6.2.
application/problem+xml
- 6.1.
- 7. References
- 7.1. Normative References
- 7.2. Informative References