latestOpenAPI 3.0.02026-08-121915501.4 MB

87d29dc7b4fe

Environment variables

Retrieve an environment variable

Show details of a specific environment variable. Uses the "key" field for selection.

get/v1/variables/{key}

Path parameters

keystring required

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

Example:API_KEY

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

Headers

x-checkly-accountstring uuid

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

Response

Successful

keystring required

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

valuestring nullable required

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

lockedboolean required

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

secretboolean required

Whether the environment variable is stored as a secret.

Example response

{
  "key": "API_KEY"
}