实例级 CI/CD 变量 API

列出所有实例变量

  • description 参数引入于极狐GitLab 16.8。

获取所有实例级变量的列表。

GET /admin/ci/variables

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables"

[
  {
    "key": "TEST_VARIABLE_1",
    "variable_type": "env_var",
    "value": "TEST_1",
    "protected": false,
    "masked": false,
    "raw": false
  },
  {
    "key": "TEST_VARIABLE_2",
    "variable_type": "env_var",
    "value": "TEST_2",
    "protected": false,
    "masked": false,
    "raw": false
  }
]

显示实例变量详情

  • description 参数引入于极狐GitLab 16.8。

获取特定实例级变量的详情。

GET /admin/ci/variables/:key
参数 类型 是否必需 描述
key string yes 变量的 key 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables/TEST_VARIABLE_1"

{
  "key": "TEST_VARIABLE_1",
  "variable_type": "env_var",
  "value": "TEST_1",
  "protected": false,
  "masked": false,
  "raw": false
}

创建实例变量

  • description 参数引入于极狐GitLab 16.8。

创建新的实例级变量。

可以更改实例级别变量的最大数量。

POST /admin/ci/variables
参数 类型 是否必需 描述
key string yes 变量的 key。最大 255 个字符。只能是 A-Z、a-z、0-9 或 _
value string yes 变量的 value。最大 10,000 个字符
description string No 变量的描述。最大 255 个字符。
masked boolean no 变量是否隐藏
protected boolean no 变量是否受保护
raw boolean no 变量是否可扩展
variable_type string no 变量的类型。可用类型为：env_var（默认）和 file 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/admin/ci/variables" --form "key=NEW_VARIABLE" --form "value=new value"

{
  "key": "NEW_VARIABLE",
  "value": "new value",
  "variable_type": "env_var",
  "protected": false,
  "masked": false,
  "raw": false
}

更新实例变量

  • description 参数引入于极狐GitLab 16.8。

更新实例级变量。

PUT /admin/ci/variables/:key
参数 类型 是否必需 描述
description string No 变量的描述。最大 255 个字符。
key string yes 变量的 key。最大 255 个字符。只能是 A-Z、a-z、0-9 或 _
masked boolean no 变量是否隐藏
protected boolean no 变量是否受保护
raw boolean no 变量是否可扩展
value string yes 变量的 value。最大 10,000 个字符
variable_type string no 变量的类型。可用类型为：env_var（默认）和 file 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/admin/ci/variables/NEW_VARIABLE" --form "value=updated value"

{
  "key": "NEW_VARIABLE",
  "value": "updated value",
  "variable_type": "env_var",
  "protected": true,
  "masked": true,
  "raw": true
}

移除实例变量

移除实例级变量。

DELETE /admin/ci/variables/:key
参数 类型 是否必需 描述
key string yes 变量的 key 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1"