Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Environment variables

Retrieve an environment variable

Changed on Oct 31, 2026

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

get/v1/variables/{key}

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/variables/:key/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

keystring required

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

Example:API_KEY

Headers

x-checkly-accountstring uuid

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"
}

Changes

Oct 31, 2026bc90d1bfa738 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Aug 12, 202687d29dc7b4fe Revision changes
- breaking
  for the path request parameter key, the minLength was increased from 0 to 1
- breaking
  for the header request parameter x-checkly-account, the format changed from no format to uuid
- breaking
  the response property became nullable for the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response's property default value false was removed for the status
- info
  the response's property default value false was removed for the status
- info
  removed the 401.00 enum value from the response property for the response status
- info
  removed the 403.00 enum value from the response property for the response status
- info
  removed the 404.00 enum value from the response property for the response status
- info
  removed the 429.00 enum value from the response property for the response status
- info
  removed the Forbidden enum value from the response property for the response status
- info
  removed the Not Found enum value from the response property for the response status
- info
  removed the Too Many Requests enum value from the response property for the response status
- info
  removed the Unauthorized enum value from the response property for the response status

Operation history