PYpydantic
Projects
Variables

Update Variable

Update an existing variable definition, optionally with labels and versions.

Fields present and set to None will be cleared. Fields not present will not be changed.

Requires: User token with project:write_variables scope.

put/v1/projects/{project_id}/variables/{name}/

Request

Path parameters

namestring required
project_idstring uuid required

Request body

namestring
descriptionstring nullable
json_schemaobject nullable
template_inputs_schemaobject nullable
type_idstring uuid nullable
aliasesstring[] nullable
examplestring nullable
externalboolean
labelsobject

Response

Successful Response

idstring uuid required
project_idstring uuid required
type_idstring uuid nullable required
type_namestring nullable required
kind'general' | 'prompt' required
namestring required
display_namestring nullable required
prompt_slugstring nullable required
descriptionstring nullable required
labelsobject required
aliasesstring[] nullable required
examplestring nullable required
externalboolean required
created_atstring date-time required
updated_atstring date-time required
created_by_namestring nullable required
updated_by_namestring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.