gitlab-org--gitlab-foss/doc/api/group_level_variables.md

161 lines
5.3 KiB
Markdown
Raw Normal View History

---
stage: Verify
group: Pipeline Authoring
info: 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 **(FREE)**
2016-01-07 08:10:49 -05:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34519) in GitLab 9.5
2017-07-19 07:57:27 -04:00
## List group variables
2016-01-07 08:10:49 -05:00
2017-07-19 07:57:27 -04:00
Get list of a group's variables.
2016-01-07 08:10:49 -05:00
```plaintext
2017-07-19 07:57:27 -04:00
GET /groups/:id/variables
2016-01-07 08:10:49 -05:00
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
| `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 |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables"
```
2016-01-07 08:10:49 -05:00
```json
[
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
"value": "TEST_1",
"protected": false,
"masked": false,
"environment_scope": "*"
2016-01-07 08:10:49 -05:00
},
{
"key": "TEST_VARIABLE_2",
"variable_type": "env_var",
"value": "TEST_2",
"protected": false,
"masked": false,
"environment_scope": "*"
2016-01-07 08:10:49 -05:00
}
]
```
## Show variable details
2017-07-19 07:57:27 -04:00
Get the details of a group's specific variable.
2016-01-07 08:10:49 -05:00
```plaintext
2017-07-19 07:57:27 -04:00
GET /groups/:id/variables/:key
2016-01-07 08:10:49 -05:00
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
| `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 |
| `key` | string | yes | The `key` of a variable |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"
```
2016-01-07 08:10:49 -05:00
```json
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
"value": "TEST_1",
"protected": false,
"masked": false,
"environment_scope": "*"
2016-01-07 08:10:49 -05:00
}
```
## Create variable
2017-07-19 07:57:27 -04:00
Create a new variable.
2016-01-07 08:10:49 -05:00
```plaintext
2017-07-19 07:57:27 -04:00
POST /groups/:id/variables
2016-01-07 08:10:49 -05:00
```
| Attribute | Type | required | Description |
|-----------------|---------|----------|-----------------------|
| `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 |
| `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](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable |
```shell
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-07 08:10:49 -05:00
```json
{
"key": "NEW_VARIABLE",
2017-05-25 07:49:46 -04:00
"value": "new value",
"variable_type": "env_var",
"protected": false,
"masked": false,
"environment_scope": "*"
2016-01-07 08:10:49 -05:00
}
```
## Update variable
2017-07-19 07:57:27 -04:00
Update a group's variable.
2016-01-07 08:10:49 -05:00
```plaintext
2017-07-19 07:57:27 -04:00
PUT /groups/:id/variables/:key
2016-01-07 08:10:49 -05:00
```
| Attribute | Type | required | Description |
|-----------------|---------|----------|-------------------------|
| `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 |
| `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](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable |
```shell
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-07 08:10:49 -05:00
```json
{
"key": "NEW_VARIABLE",
2017-05-25 07:49:46 -04:00
"value": "updated value",
"variable_type": "env_var",
"protected": true,
"masked": true,
"environment_scope": "*"
2016-01-07 08:10:49 -05:00
}
```
## Remove variable
2017-07-19 07:57:27 -04:00
Remove a group's variable.
2016-01-07 08:10:49 -05:00
```plaintext
2017-07-19 07:57:27 -04:00
DELETE /groups/:id/variables/:key
2016-01-07 08:10:49 -05:00
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
| `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 |
| `key` | string | yes | The `key` of a variable |
```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"
```