Environment variables

List all environment variables

Changed on

Lists all current environment variables in your account.

get/v1/variables

Request

Query parameters

limitinteger

Limit the number of results

pagenumber

Page number

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

    • 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

    • 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

      for the query request parameter page, the exclusiveMinimum was set to true

    • warning

      for the query request parameter page, the min was set to 0.00

    • 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'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 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 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