パイプライン・トリガー・トークンAPI

APIを使ったパイプラインのトリガーについては、こちらをご覧ください。

プロジェクト・トリガー・トークンのリスト

プロジェクトのパイプライン・トリガー・トークンのリストを取得します。

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

[
    {
        "id": 10,
        "description": "my trigger",
        "created_at": "2016-01-07T09:53:58.235Z",
        "last_used": null,
        "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
        "updated_at": "2016-01-07T09:53:58.235Z",
        "owner": null
    }
]

トリガートークンが認証ユーザーによって作成された場合、トリガートークンは全角で表示されます。他のユーザーによって作成されたトリガートークンは、4文字に短縮されます。

トリガートークンの詳細を取得

プロジェクトのパイプライン・トリガー・トークンの詳細を取得します。

GET /projects/:id/triggers/:trigger_id
属性種類必須説明
id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス
trigger_id整数。はいトリガーID
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

トリガートークンの作成

プロジェクトのパイプライン・トリガー・トークンを作成します。

POST /projects/:id/triggers
属性種類必須説明
id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス
description文字列です。はいトリガー名
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --form description="my description" "https://gitlab.example.com/api/v4/projects/1/triggers"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

パイプライントリガートークンの更新

プロジェクトのパイプライン・トリガー・トークンを更新します。

PUT /projects/:id/triggers/:trigger_id
属性種類必須説明
id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス
trigger_id整数。はいトリガーID
description文字列です。なしトリガー名
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --form description="my description" "https://gitlab.example.com/api/v4/projects/1/triggers/10"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

パイプライン・トリガー・トークンの削除

プロジェクトのパイプライン・トリガー・トークンを削除します。

DELETE /projects/:id/triggers/:trigger_id
属性種類必須説明
id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス
trigger_id整数。はいトリガーID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5"

トークンを使ったパイプラインのトリガー

認証にパイプライントリガートークンまたはCI/CDジョブトークンを使用してパイプラインをトリガーします。

CI/CDジョブトークンを使用すると、トリガーされたパイプラインはマルチプロジェクトパイプラインになります。リクエストを認証したジョブはアップストリームパイプラインに関連付けられ、パイプライングラフに表示されます。

ジョブでトリガートークンを使用する場合、ジョブはアップストリームパイプラインに関連付けられません。

POST /projects/:id/trigger/pipeline

サポートされる属性：

属性種類必須説明
id整数/文字列はい プロジェクトのIDまたはURLエンコードされたパス。
ref文字列です。はいパイプラインを実行するブランチまたはタグ。
token文字列です。はいトリガートークンまたはCI/CDジョブトークン。
variablesハッシュなしパイプライン変数を含むキー値の文字列のマップ。例:{ VAR1: "value1", VAR2: "value2" }.

リクエストの例

curl --request POST --form "variables[VAR1]=value1" --form "variables[VAR2]=value2" "https://gitlab.example.com/api/v4/projects/123/trigger/pipeline?token=2cb1840fb9dfc9fb0b7b1609cd29cb&ref=main"

応答例

{
  "id": 257,
  "iid": 118,
  "project_id": 123,
  "sha": "91e2711a93e5d9e8dddfeb6d003b636b25bf6fc9",
  "ref": "main",
  "status": "created",
  "source": "trigger",
  "created_at": "2022-03-31T01:12:49.068Z",
  "updated_at": "2022-03-31T01:12:49.068Z",
  "web_url": "http://127.0.0.1:3000/test-group/test-project/-/pipelines/257",
  "before_sha": "0000000000000000000000000000000000000000",
  "tag": false,
  "yaml_errors": null,
  "user": {
    "id": 1,
    "username": "root",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://127.0.0.1:3000/root"
  },
  "started_at": null,
  "finished_at": null,
  "committed_at": null,
  "duration": null,
  "queued_duration": null,
  "coverage": null,
  "detailed_status": {
    "icon": "status_created",
    "text": "created",
    "label": "created",
    "group": "created",
    "tooltip": "created",
    "has_details": true,
    "details_path": "/test-group/test-project/-/pipelines/257",
    "illustration": null,
    "favicon": "/assets/ci_favicons/favicon_status_created-4b975aa976d24e5a3ea7cd9a5713e6ce2cd9afd08b910415e96675de35f64955.png"
  }
}