debian-mirror-gitlab/doc/api/project_level_variables.md
2020-08-09 17:41:57 +05:30

6.1 KiB

Project-level Variables API

List project variables

Get list of a project's variables.

GET /projects/:id/variables
Attribute Type required Description
id integer/string yes The ID of a project or urlencoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables"
[
    {
        "key": "TEST_VARIABLE_1",
        "variable_type": "env_var",
        "value": "TEST_1"
    },
    {
        "key": "TEST_VARIABLE_2",
        "variable_type": "env_var",
        "value": "TEST_2"
    }
]

Show variable details

Get the details of a project's specific variable.

GET /projects/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a project or urlencoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user
key string yes The key of a variable
filter hash no Available filters: [environment_scope]. See the filter parameter details.
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/TEST_VARIABLE_1"
{
    "key": "TEST_VARIABLE_1",
    "variable_type": "env_var",
    "value": "TEST_1",
    "protected": false,
    "masked": true
}

Create variable

Create a new variable.

POST /projects/:id/variables
Attribute Type required Description
id integer/string yes The ID of a project or urlencoded NAMESPACE/PROJECT_NAME of the project 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 string no The environment_scope of the variable
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"
{
    "key": "NEW_VARIABLE",
    "value": "new value",
    "protected": false,
    "variable_type": "env_var",
    "masked": false,
    "environment_scope": "*"
}

Update variable

Update a project's variable.

PUT /projects/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a project or urlencoded NAMESPACE/PROJECT_NAME of the project 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 string no The environment_scope of the variable
filter hash no Available filters: [environment_scope]. See the filter parameter details.
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/NEW_VARIABLE" --form "value=updated value"
{
    "key": "NEW_VARIABLE",
    "value": "updated value",
    "variable_type": "env_var",
    "protected": true,
    "masked": false,
    "environment_scope": "*"
}

Remove variable

Remove a project's variable.

DELETE /projects/:id/variables/:key
Attribute Type required Description
id integer/string yes The ID of a project or urlencoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user
key string yes The key of a variable
filter hash no Available filters: [environment_scope]. See the filter parameter details.
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1"

The filter parameter

  • Introduced 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:

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 can enable it for your instance.

To enable it:

Feature.enable(:ci_variables_api_filter_environment_scope)

To disable it:

Feature.disable(:ci_variables_api_filter_environment_scope)