Getting Started

Authentication
Rate Limits

Checkly Public API

Accounts
Alert channels
Alert notifications
- Lists all alert notificationsget
Analytics
Badges
- /v1/badges/checks/{checkId}get
- /v1/badges/groups/{groupId}get
Check alerts
- List all alerts for your accountget
- List alerts for a specific checkget
Check groups
Check results
Check status
- List all check statusesget
- Retrieve check status detailsget
Checks
Heartbeats
Client certificates
Dashboards
Incidents
Incident Updates
Location
- Lists all supported locationsget
Maintenance windows
Private locations
Reporting
- Generates a report with aggregate statistics for checks and check groups.get
Runtimes
- Lists all supported runtimesget
- Shows details for one specific runtimeget
Snippets
Static IPs
Triggers
Environment variables

Getting Started

Authentication
Rate Limits

Checkly Public API

Accounts
Alert channels
Alert notifications
- Lists all alert notificationsget
Analytics
Badges
- /v1/badges/checks/{checkId}get
- /v1/badges/groups/{groupId}get
Check alerts
- List all alerts for your accountget
- List alerts for a specific checkget
Check groups
Check results
Check status
- List all check statusesget
- Retrieve check status detailsget
Checks
Heartbeats
Client certificates
Dashboards
Incidents
Incident Updates
Location
- Lists all supported locationsget
Maintenance windows
Private locations
Reporting
- Generates a report with aggregate statistics for checks and check groups.get
Runtimes
- Lists all supported runtimesget
- Shows details for one specific runtimeget
Snippets
Static IPs
Triggers
Environment variables

Update an environment variable

put https://api.checklyhq.com/v1/variables/{key}

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.

URL Expired

The URL for this request expired after 30 days.

Path Params

key

string

required

Body Params

key

string

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

value

string

required

The value of the environment variable.

locked

boolean

Defaults to false

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

secret

boolean

Defaults to false

Set an environment variable as secret. Once set, its value cannot be unlocked.

Headers

x-checkly-account

string

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

Responses

Response body

object

key

string

required

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

value

string

required

locked

boolean

Defaults to false

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

secret

boolean

Defaults to false

Set an environment variable as secret. Once set, its value cannot be unlocked.

Response body

object

statusCode

number

required

401

error

string

required

Unauthorized

message

string

attributes

object

Has additional fields

Response body

object

statusCode

number

required

403

error

string

required

Forbidden

message

string

Response body

object

statusCode

number

required

404

error

string

required

Not Found

message

string

Response body

object

statusCode

number

required

429

error

string

required

Too Many Requests

message

string

attributes

object

Has additional fields

Updated 7 months ago

Retrieve an environment variable

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://api.checklyhq.com/v1/variables/key \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "locked": false,
8
  "secret": false
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 7 months ago

Retrieve an environment variable

Did this page help you?

Getting Started
Authentication
Rate Limits

Checkly Public API
Accounts
[beta] Fetch a given account detailsget
[beta] Fetch current account detailsget
[beta] Fetch user accountsget
Alert channels
Update the subscriptions of an alert channelput
Update an alert channelput
Retrieve an alert channelget
Delete an alert channeldelete
Create an alert channelpost
List all alert channelsget
Alert notifications
Lists all alert notificationsget
Analytics
TCP checksget
Multistep checksget
List all available reporting metrics.get
Heartbeat checksget
Browser checksget
API checksget
Badges
/v1/badges/groups/{groupId}get
/v1/badges/checks/{checkId}get
Check alerts
List alerts for a specific checkget
List all alerts for your accountget
Check groups
Retrieve all checks in a specific group with group settings appliedget
Update a check groupput
Retrieve a check groupget
Delete a check group.delete
Retrieve one check in a specific group with group settings appliedget
Create a check grouppost
List all check groupsget
Check results
Lists all check resultsget
Retrieve a check resultget
Lists all check resultsget
Check status
Retrieve check status detailsget
List all check statusesget
Checks
Update a checkput
Retrieve a checkget
Delete a checkdelete
Update an TCP checkput
Create a TCP checkpost
Update a multi-step checkput
Create a multi-step checkpost
Update a browser checkput
Create a browser checkpost
Update an API checkput
Create an API checkpost
Create a checkpost
List all checksget
Heartbeats
Get a specific Heartbeat eventget
Get a list of events for a heartbeatget
Get heartbeat availabilityget
Update a heartbeat checkput
Create a heartbeat checkpost
Client certificates
Shows one client certificate.get
Deletes a client certificate.delete
Creates a new client certificate.post
Lists all client certificates.get
Dashboards
Update a dashboardput
Retrieve a dashboardget
Delete a dashboarddelete
Create a dashboardpost
List all dashboardsget
Incidents
Update an incidentput
Retrieve an incidentget
Delete an incidentdelete
Create an incidentpost
Incident Updates
Update an incident updateput
Delete an incident updatedelete
Create an incident updatepost
Location
Lists all supported locationsget
Maintenance windows
Update a maintenance windowput
Retrieve a maintenance windowget
Delete a maintenance windowdelete
Create a maintenance windowpost
List all maintenance windowsget
Private locations
Get private location health metrics from a window of time.get
Remove an existing API key for a private locationdelete
Generate a new API Key for a private locationpost
Update a private locationput
Retrieve a private locationget
Remove a private locationdelete
Create a private locationpost
List all private locationsget
Reporting
Generates a report with aggregate statistics for checks and check groups.get
Runtimes
Shows details for one specific runtimeget
Lists all supported runtimesget
Snippets
Update a snippetput
Retrieve a snippetget
Delete a snippetdelete
Create a snippetpost
List all snippetsget
Static IPs
Lists all source IPv6s for check runs as a txt fileget
Lists all source IPv6s for check runsget
Lists all source IPv6s for check runsget
Lists all source IPs for check runs as txt fileget
Lists all source IPs for check runsget
Lists all source IPs for check runsget
Triggers
Create the check triggerpost
Get the check triggerget
Delete the check triggerdelete
Create the check group triggerpost
Get the check group triggerget
Delete the check group triggerdelete
Environment variables
Update an environment variableput
Retrieve an environment variableget
Delete an environment variabledelete
Create an environment variablepost
List all environment variablesget

Getting Started
Authentication
Rate Limits

Checkly Public API
Accounts
[beta] Fetch a given account detailsget
[beta] Fetch current account detailsget
[beta] Fetch user accountsget
Alert channels
Update the subscriptions of an alert channelput
Update an alert channelput
Retrieve an alert channelget
Delete an alert channeldelete
Create an alert channelpost
List all alert channelsget
Alert notifications
Lists all alert notificationsget
Analytics
TCP checksget
Multistep checksget
List all available reporting metrics.get
Heartbeat checksget
Browser checksget
API checksget
Badges
/v1/badges/groups/{groupId}get
/v1/badges/checks/{checkId}get
Check alerts
List alerts for a specific checkget
List all alerts for your accountget
Check groups
Retrieve all checks in a specific group with group settings appliedget
Update a check groupput
Retrieve a check groupget
Delete a check group.delete
Retrieve one check in a specific group with group settings appliedget
Create a check grouppost
List all check groupsget
Check results
Lists all check resultsget
Retrieve a check resultget
Lists all check resultsget
Check status
Retrieve check status detailsget
List all check statusesget
Checks
Update a checkput
Retrieve a checkget
Delete a checkdelete
Update an TCP checkput
Create a TCP checkpost
Update a multi-step checkput
Create a multi-step checkpost
Update a browser checkput
Create a browser checkpost
Update an API checkput
Create an API checkpost
Create a checkpost
List all checksget
Heartbeats
Get a specific Heartbeat eventget
Get a list of events for a heartbeatget
Get heartbeat availabilityget
Update a heartbeat checkput
Create a heartbeat checkpost
Client certificates
Shows one client certificate.get
Deletes a client certificate.delete
Creates a new client certificate.post
Lists all client certificates.get
Dashboards
Update a dashboardput
Retrieve a dashboardget
Delete a dashboarddelete
Create a dashboardpost
List all dashboardsget
Incidents
Update an incidentput
Retrieve an incidentget
Delete an incidentdelete
Create an incidentpost
Incident Updates
Update an incident updateput
Delete an incident updatedelete
Create an incident updatepost
Location
Lists all supported locationsget
Maintenance windows
Update a maintenance windowput
Retrieve a maintenance windowget
Delete a maintenance windowdelete
Create a maintenance windowpost
List all maintenance windowsget
Private locations
Get private location health metrics from a window of time.get
Remove an existing API key for a private locationdelete
Generate a new API Key for a private locationpost
Update a private locationput
Retrieve a private locationget
Remove a private locationdelete
Create a private locationpost
List all private locationsget
Reporting
Generates a report with aggregate statistics for checks and check groups.get
Runtimes
Shows details for one specific runtimeget
Lists all supported runtimesget
Snippets
Update a snippetput
Retrieve a snippetget
Delete a snippetdelete
Create a snippetpost
List all snippetsget
Static IPs
Lists all source IPv6s for check runs as a txt fileget
Lists all source IPv6s for check runsget
Lists all source IPv6s for check runsget
Lists all source IPs for check runs as txt fileget
Lists all source IPs for check runsget
Lists all source IPs for check runsget
Triggers
Create the check triggerpost
Get the check triggerget
Delete the check triggerdelete
Create the check group triggerpost
Get the check group triggerget
Delete the check group triggerdelete
Environment variables
Update an environment variableput
Retrieve an environment variableget
Delete an environment variabledelete
Create an environment variablepost
List all environment variablesget

200Successful

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests