Sign in

v2

latestOpenAPI 3.0.02026-08-013312111.4 MB
Pipelines

Update variable for a workspace

Update a workspace level variable.

put/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}

Path parameters

workspacestring required

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

variable_uuidstring required

The UUID of the variable.

Request body

typestring required
uuidstring

The UUID identifying the variable.

keystring

The unique name of the variable.

valuestring

The value of the variable. If the variable is secured, this will be empty.

securedboolean

If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

Response

The variable was updated.

typestring required
uuidstring

The UUID identifying the variable.

keystring

The unique name of the variable.

valuestring

The value of the variable. If the variable is secured, this will be empty.

securedboolean

If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.