2020-10-28 15:08:49 +00:00
---
2021-04-23 15:09:37 +00:00
stage: Verify
2021-05-27 03:10:55 +00:00
group: Pipeline Authoring
2022-09-21 21:13:33 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-28 15:08:49 +00:00
---
2021-09-15 15:10:13 +00:00
# Group-level Variables API **(FREE)**
2016-01-07 13:10:49 +00:00
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34519) in GitLab 9.5
2017-08-18 15:55:04 +00:00
2017-07-19 11:57:27 +00:00
## List group variables
2016-01-07 13:10:49 +00:00
2017-07-19 11:57:27 +00:00
Get list of a group's variables.
2016-01-07 13:10:49 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-07-19 11:57:27 +00:00
GET /groups/:id/variables
2016-01-07 13:10:49 +00:00
```
2016-01-13 19:23:48 +00:00
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2016-01-13 19:23:48 +00:00
2020-02-27 09:09:01 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/groups/1/variables"
2016-01-13 19:23:48 +00:00
```
2016-01-07 13:10:49 +00:00
```json
[
{
"key": "TEST_VARIABLE_1",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2020-02-24 15:09:10 +00:00
"value": "TEST_1",
"protected": false,
2021-04-16 03:09:00 +00:00
"masked": false,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
},
{
"key": "TEST_VARIABLE_2",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2020-02-24 15:09:10 +00:00
"value": "TEST_2",
"protected": false,
2021-04-16 03:09:00 +00:00
"masked": false,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
}
]
```
## Show variable details
2017-07-19 11:57:27 +00:00
Get the details of a group's specific variable.
2016-01-07 13:10:49 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-07-19 11:57:27 +00:00
GET /groups/:id/variables/:key
2016-01-07 13:10:49 +00:00
```
2016-01-13 19:23:48 +00:00
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2016-01-13 21:44:11 +00:00
| `key` | string | yes | The `key` of a variable |
2016-01-13 19:23:48 +00:00
2020-02-27 09:09:01 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"
2016-01-13 19:23:48 +00:00
```
2016-01-07 13:10:49 +00:00
```json
{
"key": "TEST_VARIABLE_1",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2020-02-24 15:09:10 +00:00
"value": "TEST_1",
"protected": false,
2021-04-16 03:09:00 +00:00
"masked": false,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
}
```
## Create variable
2017-07-19 11:57:27 +00:00
Create a new variable.
2016-01-07 13:10:49 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-07-19 11:57:27 +00:00
POST /groups/:id/variables
2016-01-07 13:10:49 +00:00
```
2019-05-06 13:11:42 +00:00
| Attribute | Type | required | Description |
|-----------------|---------|----------|-----------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2019-05-06 13:11:42 +00:00
| `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 |
2020-02-24 15:09:10 +00:00
| `masked` | boolean | no | Whether the variable is masked |
2021-06-28 15:08:03 +00:00
| `environment_scope` ** (PREMIUM)** | string | no | The [environment scope ](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable ) of a variable |
2016-01-13 19:23:48 +00:00
2020-02-27 09:09:01 +00:00
```shell
2021-06-02 15:09:59 +00:00
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"
2016-01-13 19:23:48 +00:00
```
2016-01-07 13:10:49 +00:00
```json
{
"key": "NEW_VARIABLE",
2017-05-25 11:49:46 +00:00
"value": "new value",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2020-02-24 15:09:10 +00:00
"protected": false,
2021-04-16 03:09:00 +00:00
"masked": false,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
}
```
## Update variable
2017-07-19 11:57:27 +00:00
Update a group's variable.
2016-01-07 13:10:49 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-07-19 11:57:27 +00:00
PUT /groups/:id/variables/:key
2016-01-07 13:10:49 +00:00
```
2019-05-06 13:11:42 +00:00
| Attribute | Type | required | Description |
|-----------------|---------|----------|-------------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2019-05-06 13:11:42 +00:00
| `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 |
2020-02-24 15:09:10 +00:00
| `masked` | boolean | no | Whether the variable is masked |
2021-06-28 15:08:03 +00:00
| `environment_scope` ** (PREMIUM)** | string | no | The [environment scope ](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable ) of a variable |
2016-01-13 19:23:48 +00:00
2020-02-27 09:09:01 +00:00
```shell
2021-06-02 15:09:59 +00:00
curl --request PUT --header "PRIVATE-TOKEN: < your_access_token > " \
"https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"
2016-01-13 19:23:48 +00:00
```
2016-01-07 13:10:49 +00:00
```json
{
"key": "NEW_VARIABLE",
2017-05-25 11:49:46 +00:00
"value": "updated value",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2020-02-24 15:09:10 +00:00
"protected": true,
2021-04-16 03:09:00 +00:00
"masked": true,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
}
```
## Remove variable
2017-07-19 11:57:27 +00:00
Remove a group's variable.
2016-01-07 13:10:49 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-07-19 11:57:27 +00:00
DELETE /groups/:id/variables/:key
2016-01-07 13:10:49 +00:00
```
2016-01-13 19:23:48 +00:00
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2016-01-13 21:44:11 +00:00
| `key` | string | yes | The `key` of a variable |
2016-01-13 19:23:48 +00:00
2020-02-27 09:09:01 +00:00
```shell
2021-06-02 15:09:59 +00:00
curl --request DELETE --header "PRIVATE-TOKEN: < your_access_token > " \
"https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"
2016-01-13 19:23:48 +00:00
```