Netlify · Schema

envVarValue

Environment variable value model definition

CDNCloudContinuous DeploymentEdge ComputingJAMstackServerlessServerless FunctionsStatic SitesWeb HostingWebsites

Properties

Name	Type	Description
id	string	The environment variable value's universally unique ID
value	string	The environment variable's unencrypted value
context	string	The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.
context_parameter	string	An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/envVarValue",
  "title": "envVarValue",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The environment variable value's universally unique ID",
      "x-faker": "datatype.uuid"
    },
    "value": {
      "type": "string",
      "description": "The environment variable's unencrypted value",
      "x-faker": "internet.password"
    },
    "context": {
      "type": "string",
      "description": "The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.",
      "enum": [
        "all",
        "dev",
        "branch-deploy",
        "deploy-preview",
        "production",
        "branch"
      ]
    },
    "context_parameter": {
      "type": "string",
      "description": "An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`."
    }
  },
  "description": "Environment variable value model definition"
}