Environment variables

Multiple API checks can target the same server/service. In this case, your checks might need the same configuration item like an authentication token, a specific user name or even just some specific part of the URL. You can use global variables to ‘DRY’ up your checks and store these variables in just one place.

Managing variables

You can add variables on the Environment variables tab. The variables stored here are globally accessible throughout Checkly, hence the “Global environment variables” title*.

All variables are stored as string values. You can click the lock icon to encrypt the values and hide the value from all users that do not have write access.

adding variables

Accessing variables in API checks

Environment variables are exposed to your API checks using the common Handlebars/Moustache templating delimiters, i.e. {{BASIC_PWD}}. Variables can be used in the following API checks fields:

  • URL
  • Body
  • Header values
  • Query parameters values
  • Basic authentication username and password

When typing in most of the variable-enabled fields we show a small helper popup to help select the right variable.

access variables

Note, just the Body input field does not show this helper popup.

Template function and built-in variables

Next to your own variables, you can reference some built-in helpers:

  • You can access the current data center location using the implicit {{REGION}} variable. This resolves to the AWS region name, i.e. us-east-1.
  • You can use {{$UUID}} to generate a random UUID/v4, i.e. 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d.
  • You can use {{RANDOM_NUMBER}} to generate a random decimal number between 0 and 1000, i.e. 345.