summaryrefslogtreecommitdiff
path: root/doc/api/group_level_variables.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-02-24 15:09:10 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-02-24 15:09:10 +0000
commit7f79d4c409705a05bcf5e11dbe6e8738b0e17fe6 (patch)
tree33d2cc91b6b82a907e2eef019590119e1573e2a3 /doc/api/group_level_variables.md
parentae78b85a25cb0c19c3d6a2e4e6c7ca91ed50787d (diff)
downloadgitlab-ce-7f79d4c409705a05bcf5e11dbe6e8738b0e17fe6.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/group_level_variables.md')
-rw-r--r--doc/api/group_level_variables.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md
index f4d98bf454f..5eaf44ef6c1 100644
--- a/doc/api/group_level_variables.md
+++ b/doc/api/group_level_variables.md
@@ -23,12 +23,16 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
- "value": "TEST_1"
+ "value": "TEST_1",
+ "protected": false,
+ "masked": false
},
{
"key": "TEST_VARIABLE_2",
"variable_type": "env_var",
- "value": "TEST_2"
+ "value": "TEST_2",
+ "protected": false,
+ "masked": false
}
]
```
@@ -54,7 +58,9 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{
"key": "TEST_VARIABLE_1",
"variable_type": "env_var",
- "value": "TEST_1"
+ "value": "TEST_1",
+ "protected": false,
+ "masked": false
}
```
@@ -73,6 +79,7 @@ POST /groups/:id/variables
| `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 |
```
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"
@@ -83,7 +90,8 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
"key": "NEW_VARIABLE",
"value": "new value",
"variable_type": "env_var",
- "protected": false
+ "protected": false,
+ "masked": false
}
```
@@ -102,6 +110,7 @@ PUT /groups/:id/variables/:key
| `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 |
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"
@@ -112,7 +121,8 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab
"key": "NEW_VARIABLE",
"value": "updated value",
"variable_type": "env_var",
- "protected": true
+ "protected": true,
+ "masked": true
}
```