• プロジェクト変数の一覧
• 単一の変数の取得
• 変数の作成
• 変数の更新
• 変数の削除
• filter パラメータ

プロジェクトレベルのCI/CD変数API

プロジェクト変数の一覧

プロジェクトの変数の一覧を取得します。

GET /projects/:id/variables

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,
        "raw": false,
        "environment_scope": "*",
        "description": null
    },
    {
        "variable_type": "env_var",
        "key": "TEST_VARIABLE_2",
        "value": "TEST_2",
        "protected": false,
        "masked": false,
        "raw": false,
        "environment_scope": "*",
        "description": null
    }
]

単一の変数の取得

単一の変数の詳細を取得します。同じキーを持つ変数が複数ある場合は、filter を使用して正しいenvironment_scopeを選択します。

GET /projects/:id/variables/:key

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,
    "raw": false,
    "environment_scope": "*",
    "description": null
}

変数の作成

新しい変数を作成します。同じkey を持つ変数が既に存在する場合、新しい変数は異なるenvironment_scopeを持つ必要があります。そうでない場合、GitLab は以下のようなメッセージを返します：VARIABLE_NAME has already been taken.

POST /projects/:id/variables

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,
    "raw": false,
    "environment_scope": "*",
    "description": null
}

変数の更新

プロジェクトの変数を更新します。同じキーを持つ変数が複数ある場合は、filter を使って正しいenvironment_scopeを選択してください。

PUT /projects/:id/variables/:key

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,
    "raw": false,
    "environment_scope": "*",
    "description": "null"
}

変数の削除

プロジェクトの変数を削除します。同じキーを持つ変数が複数ある場合は、filter を使って、正しいenvironment_scopeを選択してください。

DELETE /projects/:id/variables/:key

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で機能フラグが削除されました。

複数の変数が同じkey を持つ場合、GET,PUT,DELETEリクエストが返されることがありました：

There are multiple variables with provided parameters. Please use 'filter[environment_scope]'.

environment_scope 属性と一致する変数を選択するにはfilter[environment_scope] を使います。

使用例：

• GET：

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

• PUT：

   curl --request PUT --globoff --header "PRIVATE-TOKEN: <your_access_token>" \
        "https://gitlab.example.com/api/v4/projects/1/variables/SCOPED_VARIABLE_1?value=scoped-variable-updated-value&environment_scope=production&filter[environment_scope]=production"
  

• DELETE

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