Skip to content

deployment_variable_set_env

Create or update an environment-scoped variable.

Tool

deployment_variable_set_env

Create or update an environment-scoped variable.

Set a shared variable on an environment. Shared variables are available to every service in that environment. Mark secrets with isSecret so their values are hidden in reads.

Arguments

Name
Type
Required
Description
environmentId
uuid
•
Environment to set the variable on.
key
string
•
Variable name (UPPER_SNAKE_CASE, 1–128 chars).
value
string
•
Variable value.
isSecret
boolean
—
When true, the value is stored as a secret and masked in reads.

Try it

Set DATABASE_URL as a secret on my staging environment.

When to use

Set a shared variable on an environment. Shared variables are available to every service in that environment. Mark secrets with isSecret so their values are hidden in reads.

Example

Ask your agent something like this:

Set DATABASE_URL as a secret on my staging environment.

The agent will invoke deployment_variable_set_env with these arguments:

{
  "environmentId": "env-uuid",
  "key": "DATABASE_URL",
  "value": "postgres://…",
  "isSecret": true
}

Esc

Start typing to search the docs.

↑↓navigate↵select