// Workspace Tenant Variables

Change a workspace tenant variable

Change a workspace tenant variable, for every project that uses it.

PUT/api/workspace/tenant-variable-template

Description

Only the fields you send are changed. The change applies to every project that uses the variable; the tenants' values stay as they are.

Parameters

NameInTypeRequiredDescription
templateId body string yes ID of the workspace tenant variable.
name body string no New name. Must be free among the workspace tenant variables and in every project that uses it.
variableType body string no New type. A Secret can't be changed to another type.
isRequired body boolean no Whether every tenant must have a value.
defaultValue body string no New default. "" removes it; leave it out to keep the current one.
description body string no New description.
sortOrder body integer no New position in the list.

Errors

StatusMeaning
400 Invalid templateId, an unknown variableType, a name that is taken here or in a project that uses it, or a default that is not valid for the type.
401 Missing or invalid Basic auth credentials, or the service account can't manage workspace variables in this workspace.