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

プラン: Free、Premium、Ultimate
提供形態: GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、インスタンスのCI/CD変数を操作します。

すべてのインスタンス変数をリスト表示

すべてのインスタンスレベルの変数のリストを取得します。結果のページネーションを制御するには、pageおよびper_page ページネーションパラメータを使用します。

GET /admin/ci/variables

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

[
    {
        "key": "TEST_VARIABLE_1",
        "description": null,
        "variable_type": "env_var",
        "value": "TEST_1",
        "protected": false,
        "masked": false,
        "raw": false
    },
    {
        "key": "TEST_VARIABLE_2",
        "description": null,
        "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>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/TEST_VARIABLE_1"

{
    "key": "TEST_VARIABLE_1",
    "description": null,
    "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文字。
`description`	文字列	いいえ	変数の説明。最大255文字。
`masked`	ブール値	いいえ	変数がマスクされるかどうかを指定します。
`protected`	ブール値	いいえ	変数が保護されるかどうかを指定します。
`raw`	ブール値	いいえ	変数が展開可能かどうか。
`variable_type`	文字列	いいえ	変数の種類。使用可能な種類は、`env_var`（デフォルト）と`file`です。

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables" \
  --form "key=NEW_VARIABLE" \
  --form "value=new value"

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

インスタンス変数を更新

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

PUT /admin/ci/variables/:key

属性	型	必須	説明
`description`	文字列	いいえ	変数の説明。最大255文字。
`key`	文字列	はい	変数の`key`。最大255文字、`A-Z`、`a-z`、`0-9`、および`_`のみが許可されます。
`masked`	ブール値	いいえ	変数がマスクされるかどうかを指定します。
`protected`	ブール値	いいえ	変数が保護されるかどうかを指定します。
`raw`	ブール値	いいえ	変数が展開可能かどうか。
`value`	文字列	はい	変数の`value`。最大10,000文字。
`variable_type`	文字列	いいえ	変数の種類。使用可能な種類は、`env_var`（デフォルト）と`file`です。

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/NEW_VARIABLE" \
  --form "value=updated value"

{
    "key": "NEW_VARIABLE",
    "description": null,
    "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>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1"