5.3 KiB
5.3 KiB
stage | group | info |
---|---|---|
Verify | Pipeline Authoring | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments |
Group-level Variables API
Introduced in 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 or URL-encoded path of the group owned by the authenticated user |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables"
[
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
"value": "TEST_1",
"protected": false,
"masked": false,
"environment_scope": "*"
},
{
"key": "TEST_VARIABLE_2",
"variable_type": "env_var",
"value": "TEST_2",
"protected": false,
"masked": false,
"environment_scope": "*"
}
]
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 or URL-encoded path of the group owned by the authenticated user |
key |
string | yes | The key of a variable |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
"value": "TEST_1",
"protected": false,
"masked": false,
"environment_scope": "*"
}
Create variable
Create a new variable.
POST /groups/:id/variables
Attribute | Type | required | Description |
---|---|---|---|
id |
integer/string | yes | The ID of a group or URL-encoded path of the group owned by the authenticated user |
key |
string | yes | The key of a variable; must have no more than 255 characters; only A-Z , a-z , 0-9 , and _ are allowed |
value |
string | yes | The value of a variable |
variable_type |
string | no | The type of a variable. Available types are: env_var (default) and file |
protected |
boolean | no | Whether the variable is protected |
masked |
boolean | no | Whether the variable is masked |
environment_scope (PREMIUM) |
string | no | The environment scope of a variable |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"
{
"key": "NEW_VARIABLE",
"value": "new value",
"variable_type": "env_var",
"protected": false,
"masked": false,
"environment_scope": "*"
}
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 or URL-encoded path of the group owned by the authenticated user |
key |
string | yes | The key of a variable |
value |
string | yes | The value of a variable |
variable_type |
string | no | The type of a variable. Available types are: env_var (default) and file |
protected |
boolean | no | Whether the variable is protected |
masked |
boolean | no | Whether the variable is masked |
environment_scope (PREMIUM) |
string | no | The environment scope of a variable |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"
{
"key": "NEW_VARIABLE",
"value": "updated value",
"variable_type": "env_var",
"protected": true,
"masked": true,
"environment_scope": "*"
}
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 or URL-encoded path of the group owned by the authenticated user |
key |
string | yes | The key of a variable |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"