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

178 lines
6.1 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
# Project-level Variables API
## List project variables
2017-09-10 17:25:29 +05:30
Get list of a project's variables.
2020-04-08 14:13:33 +05:30
```plaintext
GET /projects/:id/variables
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
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/projects/1/variables"
```
```json
[
{
"key": "TEST_VARIABLE_1",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
"value": "TEST_1"
},
{
"key": "TEST_VARIABLE_2",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
"value": "TEST_2"
}
]
```
## Show variable details
2017-09-10 17:25:29 +05:30
Get the details of a project's specific variable.
2020-04-08 14:13:33 +05:30
```plaintext
GET /projects/:id/variables/:key
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `key` | string | yes | The `key` of a variable |
2020-07-28 23:09:34 +05:30
| `filter` | hash | no | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). |
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/projects/1/variables/TEST_VARIABLE_1"
```
```json
{
"key": "TEST_VARIABLE_1",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2019-09-04 21:01:54 +05:30
"value": "TEST_1",
"protected": false,
"masked": true
}
```
## Create variable
2017-09-10 17:25:29 +05:30
Create a new variable.
2020-04-08 14:13:33 +05:30
```plaintext
POST /projects/:id/variables
```
2019-09-04 21:01:54 +05:30
| Attribute | Type | required | Description |
|---------------------|---------|----------|-----------------------|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.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 |
2019-10-12 21:52:04 +05:30
| `environment_scope` | string | no | The `environment_scope` of the variable |
2020-04-08 14:13:33 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"
```
```json
{
"key": "NEW_VARIABLE",
2017-09-10 17:25:29 +05:30
"value": "new value",
2019-09-04 21:01:54 +05:30
"protected": false,
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2019-09-04 21:01:54 +05:30
"masked": false,
"environment_scope": "*"
}
```
## Update variable
2017-09-10 17:25:29 +05:30
Update a project's variable.
2020-04-08 14:13:33 +05:30
```plaintext
PUT /projects/:id/variables/:key
```
2019-09-04 21:01:54 +05:30
| Attribute | Type | required | Description |
|---------------------|---------|----------|-------------------------|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.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 |
2019-10-12 21:52:04 +05:30
| `environment_scope` | string | no | The `environment_scope` of the variable |
2020-07-28 23:09:34 +05:30
| `filter` | hash | no | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). |
2020-04-08 14:13:33 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/NEW_VARIABLE" --form "value=updated value"
```
```json
{
"key": "NEW_VARIABLE",
2017-09-10 17:25:29 +05:30
"value": "updated value",
2019-07-31 22:56:46 +05:30
"variable_type": "env_var",
2019-09-04 21:01:54 +05:30
"protected": true,
"masked": false,
"environment_scope": "*"
}
```
## Remove variable
2017-09-10 17:25:29 +05:30
Remove a project's variable.
2020-04-08 14:13:33 +05:30
```plaintext
DELETE /projects/:id/variables/:key
```
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `key` | string | yes | The `key` of a variable |
2020-07-28 23:09:34 +05:30
| `filter` | hash | no | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). |
2020-04-08 14:13:33 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1"
```
2020-07-28 23:09:34 +05:30
## The `filter` parameter
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34490) in GitLab 13.2.
> - It's deployed behind a feature flag, disabled by default.
> - It's disabled on GitLab.com.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to enable it.
This parameter is used for filtering by attributes, such as `environment_scope`.
Example usage:
```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1?filter[environment_scope]=production"
```
### Enable or disable
[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md)
can enable it for your instance.
To enable it:
```ruby
Feature.enable(:ci_variables_api_filter_environment_scope)
```
To disable it:
```ruby
Feature.disable(:ci_variables_api_filter_environment_scope)
```