Control key

A mechanism to restrict usage of the global parameters.


For security reasons or when the application is in production, it is recommended that these parameters be disabled. 

This can be done by using a control key in the global settings. If a control key is specified, Berlioz parameters can only be used if the control key is also specified in the request.

For example:

<berlioz control-key="dllPQ9NHbqq0WI2hyTbg"/>


The control key can be specified in the request using any of the following solutions:


The parameter can be either in a URL query parameter or specified in the request body with application/x-www-form-urlencoded.


Alternatively, it can be specified using the Authorization HTTP header.

GET /home.html
Authorization: Berlioz dllPQ9NHbqq0WI2hyTbg

Created on , last edited on