GET
/
v1
/
variables
/
{key}
Retrieve an environment variable
curl --request GET \
  --url https://api.checklyhq.com/v1/variables/{key} \
  --header 'Authorization: <api-key>'
{
  "key": "API_KEY",
  "value": "<string>",
  "locked": false,
  "secret": false
}

​
Overview

The Get Environment Variable endpoint retrieves details about a specific environment variable by its key. This endpoint allows you to fetch individual variable configurations, including their values and security settings. Common Use Cases:
  • Variable Configuration Retrieval
  • Security Setting Verification
  • Variable Value Access
  • Configuration Management
Environment variables marked as locked/encrypted will return masked values for security purposes. Only the variable owner or account administrators can access full variable details.

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

Response

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.