インスタンスレベルのCI/CD変数API

インスタンス変数の一覧

すべてのインスタンスレベル変数のリストを取得します。

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
    }
]

インスタンス変数の詳細表示

特定のインスタンスレベル変数の詳細を取得します。

GET /admin/ci/variables/:key
属性種類必須説明
key文字列です。はい変数の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
}

インスタンス変数の作成

新しいインスタンスレベルの変数を作成します。

インスタンスレベル変数の最大数を変更できます。

POST /admin/ci/variables
属性種類必須説明
key文字列です。はい変数のkey 。最大255文字。A-Z 、a-z、0-9、_ のみ使用可能。
value文字列です。はい変数のvalue 。最大10,000文字。
variable_type文字列です。なし変数の型。使用可能な型は env_var (デフォルト) およびfile。
protectedbooleanなし変数が保護されているかどうか。
maskedbooleanなし変数がマスクされているかどうか。
rawbooleanなし変数が拡張可能かどうか。
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
}

インスタンス変数の更新

インスタンスレベルの変数を更新します。

PUT /admin/ci/variables/:key
属性種類必須説明
key文字列です。はい変数のkey 。最大255文字。A-Z 、a-z、0-9、_ のみ使用可能。
value文字列です。はい変数のvalue 。最大10,000文字。
variable_type文字列です。なし変数の型。使用可能な型は env_var (デフォルト) およびfile。
protectedbooleanなし変数が保護されているかどうか。
maskedbooleanなし変数がマスクされているかどうか。
rawbooleanなし変数が拡張可能かどうか。
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文字列です。はい変数のkey 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1"