Skip to content
shadwshadw/Docs
GuidesAPIGetting Started
Dashboard
shadw REST APIOverviewErrors
  • GETGet project settings
  • POSTSet an environment variable
  • DELDelete an environment variable
  • DELDelete a project
APIs & SDKs/shadw REST API/Set an environment variable

Set an environment variable

POSThttps://api.shadw.cloud/v1/projects/{project}/env

Add or update an environment variable. Sensitive values are encrypted at rest (ChaCha20-Poly1305). Returns the project's settings, with sensitive values returned empty.

Authentication

AuthorizationbearerToken

A platform API key (hive_…, created under Settings → API Keys) or a JWT of at most 1 hour from POST /v1/token, which is server-only once HIVE_JWT_SECRET is set. An API key scopes the request to the team it was created under.

Path parameters

projectstringRequired

The project name.

Body parameters

keystringRequired

Variable name.

valuestringRequired

Value (sealed at rest when sensitive).

target"production" | "preview" | "all"Optional

Which environments it applies to.

scope"runtime" | "build" | "all"Optional

Where the variable is available: at runtime only, during the build only, or both (default "runtime").

sensitivebooleanOptional

Encrypt at rest and mask in the UI.

ts
const response = await fetch('https://api.shadw.cloud/v1/projects/{project}/env', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY', // hive_… (Settings → API Keys)
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "key": "key",
    "value": "value",
    "target": "production",
    "scope": "runtime",
    "sensitive": true
  }),
});

const data = await response.json();
console.log(data);
Response
json
{
  "env": [
    { "key": "DATABASE_URL", "value": "", "target": "all", "scope": "runtime", "sensitive": true, "updated_ms": 1781906630000 }
  ]
  /* …the project's other settings, as in Get project settings */
}