Overview

The following response headers will be returned for all API calls made against the Partner RESTful API interface. Response headers specific to a given use-case - such as the X-Total-Count header relevant for dynamic querying of a list valued resource - are listed under the reference for the specific endpoints to which they are applicable.

📘

The X-Correlation-ID and Date headers are especially important for our troubleshooting - so we strongly recommend recording these headers, along with the request URL (and request body if applicable) in your application logs for every API request


Response Header

Description

`Content-Type`

Response content type - refer to the definition in the Mozilla Developer Network web documentation here

`Content-Length`

Response content length - refer to the definition in the Mozilla Developer Network web documentation here

`X-Correlation-ID`

A unique identifier generated for the specific API request. This identifier is used to track the API request across our internal systems and is especially important for our troubleshooting - so we highly recommend including this header in your application logs.

`X-Response-Time`

The number of seconds elapsed between our API gateway forwarding the request to our internal services and it receiving a response.

`Date`

Response date-time - refer to the definition in the Mozilla Developer Network web documentation here

`Vary`

Refer to the definition in the Mozilla Developer Network web documentation here

`Access-Control-Expose-Headers`

Refer to the definition in the Mozilla Developer Network web documentation here

`Access-Control-Allow-Origin`

Refer to the definition in the Mozilla Developer Network web documentation here

`Public-Key-Pins-Report-Only`

Refer to the definition in the Mozilla Developer Network web documentation here

`Strict-Transport-Security`

Refer to the definition in the Mozilla Developer Network web documentation here

`X-XSS-Protection`

Refer to the definition in the Mozilla Developer Network web documentation here

`X-Content-Type-Options`

Refer to the definition in the Mozilla Developer Network web documentation here

`Content-Security-Policy-Report-Only`

Refer to the definition in the Mozilla Developer Network web documentation here

`X-Permitted-Cross-Domain-Policies`

Refer to the definition in the OWASP specification documentation here

`Referrer-Policy`

Refer to the definition in the Mozilla Developer Network web documentation here

`Expect-CT`

Refer to the definition in the Mozilla Developer Network web documentation here

`Connection`

Refer to the definition in the Mozilla Developer Network web documentation here