PATCH/databases/{uuid}/envs

Update a database environment variable

Updates an environment variable for a database. Supply key and value to identify the variable and set its value; optional flags control literal, multiline, and one-time display behaviour.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
uuidstringrequired
The UUID of the database containing the environment variable to update.

Environment variable fields to update; key and value are required.

is_literalbooleanoptional
The flag to indicate if the environment variable is a literal, nothing espaced.
is_multilinebooleanoptional
The flag to indicate if the environment variable is multiline.
is_shown_oncebooleanoptional
If true, the saved value is hidden in the UI and API responses. MCP never returns environment variable values.
keystringrequired
The key of the environment variable.
valuestringrequired
The value of the environment variable.

5 status codes
201Returns the updated environment variable object, including its key, configuration flags, and timestamps.
commentstringoptional
created_atstringoptional
idintegeroptional
is_buildtimebooleanoptional
is_literalbooleanoptional
is_multilinebooleanoptional
is_previewbooleanoptional
is_runtimebooleanoptional
is_sharedbooleanoptional
is_shown_oncebooleanoptional
If true, the saved value is hidden in the UI and API responses. MCP never returns environment variable values.
keystringoptional
real_valuestringoptional
resourceable_idintegeroptional
resourceable_typestringoptional
updated_atstringoptional
uuidstringoptional
valuestringoptional
versionstringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the database resource is not found.
messagestringoptional
422Returned when request body validation fails.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, a 401 when the request is unauthenticated, and a 404 when the database resource is not found. A 422 is returned when body validation fails; key and value are required. The uuid path parameter must identify the database.