NEnetlify
environmentVariables

Get an environment variable

Returns an individual environment variable.

get/accounts/{account_id}/env/{key}

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/accounts/{account_id}/env/{key}
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Path parameters

account_idstring required

Scope response to account_id

keystring required

The environment variable key (case-sensitive)

Query parameters

site_idstring

If provided, return the environment variable for a specific site (no merging is performed)

Response

OK

keystring

The environment variable key, like ALGOLIA_ID (case-sensitive)

scopesstring[]

The scopes that this environment variable is set to

is_secretboolean

Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret.

updated_atstring date-time

The timestamp of when the value was last updated

Changes

No recorded changes to this operation across all 87 revisions of this API.