POST
/
v1
/
variables
Create an environment variable
curl --request POST \
  --url https://api.checklyhq.com/v1/variables \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "API_KEY",
  "value": "<string>",
  "locked": false,
  "secret": false
}'
{
  "key": "API_KEY",
  "value": "<string>",
  "locked": false,
  "secret": false
}

​
Overview

The Create Environment Variable endpoint allows you to add new environment variables to your Checkly account. These variables can be used across checks, scripts, and monitoring configurations to store sensitive data and reusable values. Common Use Cases:
  • API Key Storage
  • Configuration Values
  • Test Data Management
  • Sensitive Information Storage
Store sensitive information like API keys, passwords, and tokens as locked variables to ensure they are encrypted and masked in logs.
Environment variables are available across all checks in your account. Use locked variables for sensitive data to maintain security best practices.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Body

application/json
​
key
string
required

The key of the environment variable (this value cannot be changed).

Example:

"API_KEY"

​
value
string
required
​
locked
boolean
default:false

Used only in the UI to hide the value like a password.

​
secret
boolean
default:false

Set an environment variable as secret. Once set, its value cannot be unlocked.

Response

Created

​
key
string
required

The key of the environment variable (this value cannot be changed).

Example:

"API_KEY"

​
value
string
required
​
locked
boolean
default:false

Used only in the UI to hide the value like a password.

​
secret
boolean
default:false

Set an environment variable as secret. Once set, its value cannot be unlocked.