environmentVariables

List environment variables for a site

Returns all environment variables for a site. This convenience method behaves the same as getEnvVars but doesn't require an account_id as input.

get/api/v1/sites/{site_id}/env

Request

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

Path parameters

site_idstring required

Scope response to site_id

Query parameters

context_name'all' | 'dev' | 'dev-server' | 'branch-deploy' | 'deploy-preview' | 'production'

Filter by deploy context

scope'builds' | 'functions' | 'runtime' | 'post_processing'

Filter by scope

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 65 revisions of this API.