2020-07-30 12:09:33 +00:00
---
2020-08-04 06:10:16 +00:00
stage: Verify
2021-05-27 03:10:55 +00:00
group: Pipeline Authoring
2020-11-26 06:09:20 +00:00
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
2020-07-30 12:09:33 +00:00
type: reference, api
---
2019-06-06 07:57:39 +00:00
# Project-level Variables API
2016-01-07 13:10:49 +00:00
## List project variables
2017-07-19 11:57:27 +00:00
Get list of a project's variables.
2016-01-07 13:10:49 +00:00
2020-02-28 00:09:08 +00:00
```plaintext
2016-01-07 13:10:49 +00:00
GET /projects/:id/variables
```
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 project or [URL-encoded NAMESPACE/PROJECT_NAME of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2016-01-13 19:23:48 +00:00
2020-02-28 00:09:08 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/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",
2016-01-07 13:10:49 +00:00
"value": "TEST_1"
},
{
"key": "TEST_VARIABLE_2",
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2016-01-07 13:10:49 +00:00
"value": "TEST_2"
}
]
```
## Show variable details
2017-07-19 11:57:27 +00:00
Get the details of a project's specific variable.
2016-01-07 13:10:49 +00:00
2020-02-28 00:09:08 +00:00
```plaintext
2016-01-07 13:10:49 +00:00
GET /projects/:id/variables/:key
```
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 project or [URL-encoded NAMESPACE/PROJECT_NAME of the project ](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 |
2020-07-08 09:09:17 +00:00
| `filter` | hash | no | Available filters: `[environment_scope]` . See the [`filter` parameter details ](#the-filter-parameter ). |
2016-01-13 19:23:48 +00:00
2020-02-28 00:09:08 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/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",
2019-05-16 20:07:42 +00:00
"value": "TEST_1",
"protected": false,
"masked": true
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-28 00:09:08 +00:00
```plaintext
2016-01-07 13:10:49 +00:00
POST /projects/:id/variables
```
2019-06-06 07:57:39 +00:00
| Attribute | Type | required | Description |
|---------------------|---------|----------|-----------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2019-06-06 07:57:39 +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` |
2021-01-11 06:10:29 +00:00
| `protected` | boolean | no | Whether the variable is protected. Default: `false` |
| `masked` | boolean | no | Whether the variable is masked. Default: `false` |
| `environment_scope` | string | no | The `environment_scope` of the variable. Default: `*` |
2016-01-13 19:23:48 +00:00
2020-02-28 00:09:08 +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/projects/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-06-06 07:57:39 +00:00
"protected": false,
2019-05-06 13:11:42 +00:00
"variable_type": "env_var",
2019-06-06 07:57:39 +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 project's variable.
2016-01-07 13:10:49 +00:00
2020-02-28 00:09:08 +00:00
```plaintext
2016-01-07 13:10:49 +00:00
PUT /projects/:id/variables/:key
```
2019-06-06 07:57:39 +00:00
| Attribute | Type | required | Description |
|---------------------|---------|----------|-------------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2019-06-06 07:57:39 +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 |
| `masked` | boolean | no | Whether the variable is masked |
2019-08-08 18:51:52 +00:00
| `environment_scope` | string | no | The `environment_scope` of the variable |
2020-07-08 09:09:17 +00:00
| `filter` | hash | no | Available filters: `[environment_scope]` . See the [`filter` parameter details ](#the-filter-parameter ). |
2016-01-13 19:23:48 +00:00
2020-02-28 00:09:08 +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/projects/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",
2019-05-16 20:07:42 +00:00
"protected": true,
2019-06-06 07:57:39 +00:00
"masked": false,
"environment_scope": "*"
2016-01-07 13:10:49 +00:00
}
```
## Remove variable
2017-07-19 11:57:27 +00:00
Remove a project's variable.
2016-01-07 13:10:49 +00:00
2020-02-28 00:09:08 +00:00
```plaintext
2016-01-07 13:10:49 +00:00
DELETE /projects/:id/variables/:key
```
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 project or [URL-encoded NAMESPACE/PROJECT_NAME of the project ](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 |
2020-07-08 09:09:17 +00:00
| `filter` | hash | no | Available filters: `[environment_scope]` . See the [`filter` parameter details ](#the-filter-parameter ). |
2016-01-13 19:23:48 +00:00
2020-02-28 00:09:08 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --request DELETE --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1"
2016-01-13 19:23:48 +00:00
```
2020-07-08 09:09:17 +00:00
## The `filter` parameter
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34490) in GitLab 13.2.
2020-09-14 12:09:34 +00:00
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/227052) in GitLab 13.4.
2020-07-08 09:09:17 +00:00
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"
```