项目级别变量 API

列出项目变量

获取项目变量列表。

GET /projects/:id/variables
参数 类型 是否必需 描述
id integer/string yes 授权用户拥有的项目 ID 或 URL 编码的项目命名空间/项目名称
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables"
[
    {
        "variable_type": "env_var",
        "key": "TEST_VARIABLE_1",
        "value": "TEST_1",
        "protected": false,
        "masked": true,
        "environment_scope": "*"
    },
    {
        "variable_type": "env_var",
        "key": "TEST_VARIABLE_2",
        "value": "TEST_2",
        "protected": false,
        "masked": false,
        "environment_scope": "*"
    }
]

显示变量的详细信息

获取项目特定变量的详细信息。

GET /projects/:id/variables/:key
参数 类型 是否必需 描述
id integer/string yes 授权用户拥有的项目 ID 或 URL 编码的项目命名空间/项目名称
key string yes 变量的 key
filter hash no 可用过滤项:[environment_scope]。详情请参见 filter 参数详情
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,
    "environment_scope": "*"
}

创建变量

创建变量。

POST /projects/:id/variables
参数 类型 是否必需 描述
id integer/string yes 授权用户拥有的项目 ID 或 URL 编码的项目命名空间/项目名称
key string yes 变量的 key。不能超过 255 个字符。仅支持 A-Za-z0-9_
value string yes 变量的 value
variable_type string no 变量类型。可用类型为: env_var(默认)和 file
protected boolean no 变量是否受保护。默认为 false
masked boolean no 变量是否隐藏。默认为 false
environment_scope string no 变量的 environment_scope。默认为 *
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"
{
    "variable_type": "env_var",
    "key": "NEW_VARIABLE",
    "value": "new value",
    "protected": false,
    "masked": false,
    "environment_scope": "*"
}

更新变量

更新项目变量。

PUT /projects/:id/variables/:key
参数 类型 是否必需 描述
id integer/string yes 授权用户拥有的项目 ID 或 URL 编码的项目命名空间/项目名称
key string yes 变量的 key
value string yes 变量的 value
variable_type string no 变量类型。可用类型为:env_var(默认)和file
protected boolean no 变量是否受保护
masked boolean no 变量是否隐藏
environment_scope string no 变量的 environment_scope
filter hash no 可用过滤项:[environment_scope]。详情请参见 filter 参数详情
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/1/variables/NEW_VARIABLE" --form "value=updated value"
{
    "variable_type": "env_var",
    "key": "NEW_VARIABLE",
    "value": "updated value",
    "protected": true,
    "masked": false,
    "environment_scope": "*"
}

移除变量

移除项目变量。

DELETE /projects/:id/variables/:key
参数 类型 是否必需 描述
id integer/string yes 授权用户拥有的项目 ID 或 URL 编码的项目命名空间/项目名称
key string yes 变量的 key
filter hash no 可用过滤项:[environment_scope]。详情请参见 filter 参数详情
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1"

filter 参数

  • 引入于极狐GitLab 13.2。
  • 功能标志移除于极狐GitLab 13.4。

此参数按照属性过滤,例如 environment_scope

使用示例:

curl --globoff --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1?filter[environment_scope]=production"