Skip to content

deployment_variable_set

Create or update a variable on a service.

Tool

deployment_variable_set

Create or update a variable on a service.

Create or update a variable on a service. Pass `isSecret: true` to encrypt the value via KMS — this transition is irreversible (a row that is already secret cannot be downgraded to plain).

Behavior

HTTP
PUT /deployment/services/:serviceId/variables/:key

Arguments

Name
Type
Required
Description
key
string
•
No description in the catalog.
value
string
•
No description in the catalog.
isSecret
boolean
—
No description in the catalog.
serviceId
string
•
No description in the catalog.

Response

Field
Type
Always
Description
id
string
•
key
string
•
scope
string
•
value
string
•
isSecret
boolean
•
createdAt
string
•
serviceId
string
•
updatedAt
string
•
environmentId
string
•

Try it

Create or update a variable on a service.

When to use

Create or update a variable on a service. Pass `isSecret: true` to encrypt the value via KMS — this transition is irreversible (a row that is already secret cannot be downgraded to plain).

Example

Ask your agent something like this:

Create or update a variable on a service.

The agent will invoke deployment_variable_set with these arguments:

{
  "key": "<key>",
  "value": "<value>",
  "serviceId": "<serviceId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select