Back to Content

Reporting-Endpoints header

files/en-us/web/http/reference/headers/reporting-endpoints/index.md

latest2.6 KB
Original Source

The HTTP Reporting-Endpoints {{Glossary("response header")}} allows website administrators to specify one or more endpoints that can be sent reports generated by the Reporting API.

The endpoints can be used, for example, as targets for sending CSP violation reports, {{HTTPHeader("Cross-Origin-Opener-Policy")}} reports, or other generic violations.

When used for reporting Content Security Policy (CSP) errors, the header is used in combination with the {{HTTPHeader("Content-Security-Policy")}} header {{CSP("report-to")}} directive. For more details on setting up CSP reporting, see the Content Security Policy (CSP) documentation.

[!NOTE] This header replaces {{HTTPHeader("Report-To")}} {{deprecated_inline}} for declaring endpoints, and should be used in preference.

<table class="properties"> <tbody> <tr> <th scope="row">Header type</th> <td>{{Glossary("Response header")}}</td> </tr> <tr> <th scope="row"> {{Glossary("CORS-safelisted response header")}} </th> <td>No</td> </tr> </tbody> </table>

Syntax

http
Reporting-Endpoints: <endpoint>
Reporting-Endpoints: <endpoint>, …, <endpointN>
  • <endpoint>
    • : A reporting endpoint in the format <endpoint-name>="<URL>". The endpoints must have valid URIs in quoted strings (e.g., my-endpoint="https://example.com/reports") and non-secure endpoints are ignored. A comma-separated list of endpoints may be provided.

Examples

Setting a CSP violation report endpoint

The following example shows how the Reporting-Endpoints response header is used in conjunction with the {{HTTPHeader("Content-Security-Policy")}} header to indicate where CSP violation reports are sent:

http
Reporting-Endpoints: csp-endpoint="https://example.com/csp-reports"
Content-Security-Policy: default-src 'self'; report-to csp-endpoint

Specifying multiple reporting endpoints

It's possible to specify multiple endpoints that can be used for different types of violation reports.

http
Reporting-Endpoints: csp-endpoint="https://example.com/csp-reports",
                     permissions-endpoint="https://example.com/permissions-policy-reports"

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also