debian-mirror-gitlab/doc/api/group_level_variables.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

161 lines
5.3 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-06-08 01:23:25 +05:30
stage: Verify
2021-09-04 01:27:46 +05:30
group: Pipeline Authoring
2021-02-22 17:27:13 +05:30
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
2021-01-29 00:20:46 +05:30
---
2021-11-11 11:23:49 +05:30
# Group-level Variables API **(FREE)**
2017-09-10 17:25:29 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/34519) in GitLab 9.5
2017-09-10 17:25:29 +05:30
## List group variables
Get list of a group's variables.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/variables
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
2021-09-30 23:02:18 +05:30
| `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 |
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables"
2017-09-10 17:25:29 +05:30
```
```json
[
{
"key": "TEST_VARIABLE_1",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2020-04-08 14:13:33 +05:30
"value": "TEST_1",
"protected": false,
2021-04-29 21:17:54 +05:30
"masked": false,
"environment_scope": "*"
2017-09-10 17:25:29 +05:30
},
{
"key": "TEST_VARIABLE_2",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2020-04-08 14:13:33 +05:30
"value": "TEST_2",
"protected": false,
2021-04-29 21:17:54 +05:30
"masked": false,
"environment_scope": "*"
2017-09-10 17:25:29 +05:30
}
]
```
## Show variable details
Get the details of a group's specific variable.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/variables/:key
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
2021-09-30 23:02:18 +05:30
| `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 |
2017-09-10 17:25:29 +05:30
| `key` | string | yes | The `key` of a variable |
2020-04-08 14:13:33 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"
2017-09-10 17:25:29 +05:30
```
```json
{
"key": "TEST_VARIABLE_1",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2020-04-08 14:13:33 +05:30
"value": "TEST_1",
"protected": false,
2021-04-29 21:17:54 +05:30
"masked": false,
"environment_scope": "*"
2017-09-10 17:25:29 +05:30
}
```
## Create variable
Create a new variable.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
POST /groups/:id/variables
```
2019-07-31 22:56:46 +05:30
| Attribute | Type | required | Description |
|-----------------|---------|----------|-----------------------|
2021-09-30 23:02:18 +05:30
| `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-07-31 22:56:46 +05:30
| `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-04-08 14:13:33 +05:30
| `masked` | boolean | no | Whether the variable is masked |
2021-09-30 23:02:18 +05:30
| `environment_scope` **(PREMIUM)** | string | no | The [environment scope](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable |
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
```shell
2021-09-04 01:27:46 +05:30
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"
2017-09-10 17:25:29 +05:30
```
```json
{
"key": "NEW_VARIABLE",
"value": "new value",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2020-04-08 14:13:33 +05:30
"protected": false,
2021-04-29 21:17:54 +05:30
"masked": false,
"environment_scope": "*"
2017-09-10 17:25:29 +05:30
}
```
## Update variable
Update a group's variable.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
PUT /groups/:id/variables/:key
```
2019-07-31 22:56:46 +05:30
| Attribute | Type | required | Description |
|-----------------|---------|----------|-------------------------|
2021-09-30 23:02:18 +05:30
| `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-07-31 22:56:46 +05:30
| `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-04-08 14:13:33 +05:30
| `masked` | boolean | no | Whether the variable is masked |
2021-09-30 23:02:18 +05:30
| `environment_scope` **(PREMIUM)** | string | no | The [environment scope](../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable |
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"
2017-09-10 17:25:29 +05:30
```
```json
{
"key": "NEW_VARIABLE",
"value": "updated value",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2020-04-08 14:13:33 +05:30
"protected": true,
2021-04-29 21:17:54 +05:30
"masked": true,
"environment_scope": "*"
2017-09-10 17:25:29 +05:30
}
```
## Remove variable
Remove a group's variable.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
DELETE /groups/:id/variables/:key
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
2021-09-30 23:02:18 +05:30
| `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 |
2017-09-10 17:25:29 +05:30
| `key` | string | yes | The `key` of a variable |
2020-04-08 14:13:33 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"
2017-09-10 17:25:29 +05:30
```