REST API - Environment variables#

EndpointMethodDescription
/projects/{id}/envGETList variables
/projects/{id}/envPOSTCreate a variable
/projects/{id}/env/{varID}PATCHUpdate value/environment
/projects/{id}/env/{varID}DELETEDelete a variable
/projects/{id}/env/bulkPOSTUpsert many variables

Create:

{
  "key": "STRIPE_KEY",
  "value": "sk_test_123",
  "environment": "production"
}
JSON

environment is one of production, preview, development.

Bulk:

{
  "environment": "development",
  "values": { "DEBUG": "true", "LOG_LEVEL": "debug" }
}
JSON

Security#

  • Accepts the project API key (or a project-user session)
  • Scoped keys: env:read, env:write