Headers

In Mockoon you can easily define response headers for each route but also at the environment level. Response headers defined on a route will override those defined in an environment.

 Route level response headers

To add response headers like Content-Type to your route, go to the route's Headers tab and fill the name and value fields:

Complete route response header form

You can add one or more headers by clicking on the "Add header" button at the bottom of the list:

Add route response header

 Environment level response headers

You can also add response headers at the environment level. Headers defined in an environment will be overridden if they are redefined on a route. To define an environment response header:

Open the Environment Headers by clicking on the tab at the top of the window:

click on the headers tab

And add one or more headers by clicking on the "Add header" button at the bottom of the list:

Add environment header

 Specific headers

 Connection/Upgrade headers

By default, the Connection and Upgrade request headers containing something else than websocket are ignored by Mockoon and will have no effect on the response.

However, when your mock contains a WebSocket route, Mockoon will use these headers to upgrade the connection to a WebSocket connection. In this case, passing an Upgrade header without the value websocket will result in a 400 Bad Request response.

 Mockoon response headers

Mockoon adds the following headers to all responses:

  • X-Mockoon-Callback-Depth: to prevent infinite callback loops (see Using callbacks)

Route metadata headers, enabled by default in the desktop application and disabled by default in the CLI (use the --enable-route-metadata-headers flag):

  • X-Mockoon-Route-Uuid: the route UUID that handled the request.
  • X-Mockoon-Route-Response-No: the response number that handled the request (starting at 1).
  • X-Mockoon-Route-Response-Uuid: the response UUID that handled the request.