グループレベル変数API

グループ変数の一覧表示

グループの変数の一覧を取得します。

GET /groups/:id/variables
属性種類必須説明
id整数/文字列はいグループのIDまたはグループのURLエンコードされたパス 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables"

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

変数の詳細を表示

グループの特定の変数の詳細を取得します。

GET /groups/:id/variables/:key
属性種類必須説明
id整数/文字列はいグループのIDまたはグループのURLエンコードされたパス
key文字列です。はい変数のkey 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/TEST_VARIABLE_1"

{
    "key": "TEST_VARIABLE_1",
    "variable_type": "env_var",
    "value": "TEST_1",
    "protected": false,
    "masked": false,
    "raw": false,
    "environment_scope": "*",
    "description": null
}

変数の作成

新しい変数を作成します。

POST /groups/:id/variables
属性種類必須説明
id整数/文字列はいグループのIDまたはグループのURLエンコードされたパス
key文字列です。はい変数のkey; 255 文字以下でなければなりません;A-Z,a-z,0-9,_ のみ可能です。
value文字列です。はい変数のvalue
variable_type文字列です。なし変数の型。使用可能な型は env_var (デフォルト) およびfile
protectedbooleanなし変数が保護されているかどうか
maskedbooleanなし変数がマスクされているかどうか
rawbooleanなし変数を生の文字列として扱うかどうか。デフォルト：false 。trueの場合、値の変数は展開されません。
environment_scope 文字列です。なし変数の環境スコープ
description文字列です。なし変数のdescription 。デフォルト：null 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/1/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,
    "environment_scope": "*",
    "description": null
}

変数の更新

グループの変数を更新します。

PUT /groups/:id/variables/:key
属性種類必須説明
id整数/文字列はいグループのIDまたはグループのURLエンコードされたパス
key文字列です。はい変数のkey
value文字列です。はい変数のvalue
variable_type文字列です。なし変数の型。使用可能な型は env_var (デフォルト) およびfile
protectedbooleanなし変数が保護されているかどうか
maskedbooleanなし変数がマスクされているかどうか
rawbooleanなし変数を生の文字列として扱うかどうか。デフォルト：false 。trueの場合、値の変数は展開されません。
environment_scope 文字列です。なし変数の環境スコープ
description文字列です。なし変数の説明。デフォルト:null.GitLab 16.2 で導入。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/1/variables/NEW_VARIABLE" --form "value=updated value"

{
    "key": "NEW_VARIABLE",
    "value": "updated value",
    "variable_type": "env_var",
    "protected": true,
    "masked": true,
    "raw": true,
    "environment_scope": "*",
    "description": null
}

変数の削除

グループの変数を削除します。

DELETE /groups/:id/variables/:key
属性種類必須説明
id整数/文字列はいグループのIDまたはグループのURLエンコードされたパス
key文字列です。はい変数のkey 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"