Skip to content

Group-level Variables API

Introducedin GitLab 9.5

List group variables

Get list of a group's variables.

GET /groups/:id/variables
Attribute Type required Description
id integer/string yes The ID of a group orURL-encoded path of the groupowned by the authenticated user 
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/1/variables"
[{"key":"TEST_VARIABLE_1","value":"TEST_1"},{"key":"TEST_VARIABLE_2","value":"TEST_2"}]

Show variable details

Get the details of a group's specific variable.

GET /groups/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a group orURL-encoded path of the groupowned by the authenticated user
key string yes Thekeyof a variable 
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"
{"key":"TEST_VARIABLE_1","value":"TEST_1"}

Create variable

Create a new variable.

POST /groups/:id/variables
Attribute Type required Description
id integer/string yes The ID of a group orURL-encoded path of the groupowned by the authenticated user
key string yes Thekeyof a variable; must have no more than 255 characters; onlyA-Z,a-z,0-9, and_are allowed
value string yes Thevalueof a variable
protected boolean no Whether the variable is protected 
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"
{"key":"NEW_VARIABLE","value":"new value","protected":false}

Update variable

Update a group's variable.

PUT /groups/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a group orURL-encoded path of the groupowned by the authenticated user
key string yes Thekeyof a variable
value string yes Thevalueof a variable
protected boolean no Whether the variable is protected 
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"
{"key":"NEW_VARIABLE","value":"updated value","protected":true}

Remove variable

Remove a group's variable.

DELETE /groups/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a group orURL-encoded path of the groupowned by the authenticated user
key string yes Thekeyof a variable 
curl——请求删除标题“PRIVATE-TOKEN: 9 koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"
Baidu
map