Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Environment variables

Update an environment variable

Updates an environment variable. Uses the "key" field as the ID for updating. Only updates value, locked, and secret properties. Once a value is set to secret, it cannot be unset.

put/v1/variables/{key}

Path parameters

keystring required

Headers

x-checkly-accountstring

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

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

Request body

keystring

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

valuestring required

The value of the environment variable.

lockedboolean

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

secretboolean

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

Example request

{
  "key": "API_KEY",
  "value": "bAxD7biGCZL6K60Q"
}

Response

Successful

keystring required

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

valuestring required
lockedboolean

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

secretboolean

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

Example response

{
  "key": "API_KEY"
}