Skip to content

Deployment

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

NameTypeRequiredDescription
keystringNo description in the catalog.
valuestringNo description in the catalog.
isSecretbooleanNo description in the catalog.
serviceIdstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
keystring
scopestring
valuestring
isSecretboolean
createdAtstring
serviceIdstring
updatedAtstring
environmentIdstring

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.

navigateselect