Skip to main content
Environment variables are stored encrypted at rest and injected into the server process at runtime. Variable values are never returned via the API — only the variable names (keys) are exposed. Required scope: servers:read (list), servers:write (set/delete)

Reserved variable names

A small set of names are reserved for platform-injected configuration and cannot be overridden by a customer-set variable. If you POST/PUT a variable using one of these names, the call still succeeds, but the platform value is used at deploy time instead of yours — your value is silently ignored.

List env var names

Returns the names of all environment variables set on the server. Values are not returned. Response 200:

Set env var

Creates or updates an environment variable. The variable is available on the next deployment. Request body:
Response 201 (new variable) or 200 (updated variable):

Set env var by name

Creates or updates the env var identified by :name in the URL path. Request body:
Response 201 (new) or 200 (updated): Env var object (same shape as above).

Delete env var

Removes the named environment variable. The change takes effect on the next deployment. Response 204: No content.