GIgitlab
ci_variables

Update a group variable

Updates a specified group variable. If there are multiple variables with the same key, use filter to select the correct environment_scope.

put/api/v4/groups/{id}/variables/{key}

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID of a group or URL-encoded path of the group owned by the authenticated user

keystring required

The key of a variable

Request body

valuestring

The value of a variable

protectedboolean

Whether the variable is protected

maskedboolean

Whether the variable is masked

rawboolean

Whether the variable will be expanded

variable_type'env_var' | 'file'

The type of the variable. Default: env_var

environment_scopestring

The environment scope of the variable

descriptionstring

The description of the variable

Response

Update a group variable

variable_typestring required
keystring required
valuestring required
hiddenboolean
protectedboolean
maskedboolean
rawboolean
environment_scopestring
descriptionstring

Example response

{
  "variable_type": "env_var",
  "key": "TEST_VARIABLE_1",
  "value": "TEST_1",
  "environment_scope": "*",
  "description": "This variable is being used for ..."
}

Changes

No recorded changes to this operation across all 5 revisions of this API.