Skip to main content
GET
Retrieve an environment variable

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<uuid>

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

Path Parameters

key
string
required

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

Minimum string length: 1
Example:

"API_KEY"

Response

Successful

key
string
required

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

Minimum string length: 1
Example:

"API_KEY"

value
string | null
required

The value of the environment variable. Secret values are always returned as null.

locked
boolean
required

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

secret
boolean
required

Whether the environment variable is stored as a secret.