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}

Try it

Update an environment variable

cURL

curl --request PUT \
  --url https://api.checklyhq.com/v1/variables/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "bAxD7biGCZL6K60Q",
  "key": "API_KEY",
  "locked": false,
  "secret": false
}
'

200

{
  "key": "API_KEY",
  "value": "<string>",
  "locked": false,
  "secret": false
}

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

Path Parameters

key · string · required

Body

application/json

value · string · required

The value of the environment variable.

Example:

"bAxD7biGCZL6K60Q"

key · string

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

Example:

"API_KEY"

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

200

application/json

Successful

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.