ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。

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

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

プロジェクトのトリガートークンのリストを取得する

プロジェクトのパイプライントリガートークンを一覧表示します。

GET /projects/:id/triggers

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/triggers"

json
[
    {
        "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

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/triggers/5"

json
{
    "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

属性	型	必須	説明
`description`	文字列	はい	トリガー名
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス

shell
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form description="my description" \
  --url "https://gitlab.example.com/api/v4/projects/1/triggers"

json
{
    "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

属性	型	必須	説明