Sign in
Variables

Replace a variable value

Replaces a variable value and preserves the existing description when omitted.

put/api/v1/variables/{name}

Request body

valuestring required

Replacement value. Empty values are allowed.

descriptionstring

Optional operator-facing description. Omitted descriptions preserve the existing value.

Response

Variable updated

namestring required

Env-style variable name.

valuestring required

Variable value.

descriptionstring

Optional operator-facing description of the variable.

created_atstring date-time required

When the variable was first stored.

updated_atstring date-time required

When the variable was last updated.

Example response

{
  "name": "DEPLOY_ENV",
  "value": "production"
}

Changes

Changed in 1 of the 134 revisions of this API.1