2.23. trigger
ビルドトリガーを作成、一覧表示、管理します。
2.23.1. activateBuildTrigger リンクのコピーリンクがクリップボードにコピーされました!
指定したビルドトリガーをアクティブにします。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
要求の body スキーマ (application/json)
名前 | 説明 | スキーマ |
---|---|---|
config | 任意の json | object |
pull_robot | イメージのプルに使用するロボットの名前 | string |
レスポンス
2.23.2. listTriggerRecentBuilds リンクのコピーリンクがクリップボードにコピーされました!
指定したトリガーで開始するビルドを一覧表示します。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
クエリーパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
query |
limit | 返すビルドの最大数 | integer |
応答
2.23.3. manuallyStartBuildTrigger リンクのコピーリンクがクリップボードにコピーされました!
指定したトリガーからビルドを手動で開始します。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
要求の body スキーマ (application/json)
ビルドトリガーをアクティベートするための実行パラメーター (任意)
名前 | 説明 | スキーマ |
---|---|---|
branch_name | (SCM のみ) 指定した場合のビルドするブランチの名前。 | string |
commit_sha | (カスタムのみ) 指定されている場合は、git リポジトリーのチェックアウトに使用する ref/SHA1。 | string |
refs | (SCM のみ) 指定されている場合のビルドの ref。 |
応答
2.23.4. getBuildTrigger リンクのコピーリンクがクリップボードにコピーされました!
指定したビルドトリガーの情報を取得します。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
レスポンス
2.23.5. updateBuildTrigger リンクのコピーリンクがクリップボードにコピーされました!
指定したビルドトリガーを更新します。
PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
要求の body スキーマ (application/json)
ビルドトリガーを更新するオプション
名前 | 説明 | スキーマ |
---|---|---|
enabled | ビルドトリガーが有効かどうか | boolean |
応答
2.23.6. deleteBuildTrigger リンクのコピーリンクがクリップボードにコピーされました!
指定したビルドトリガーを削除します。
DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
path |
trigger_uuid | ビルドトリガーの UUID | string |
レスポンス
2.23.7. listBuildTriggers リンクのコピーリンクがクリップボードにコピーされました!
指定したリポジトリーのトリガーを一覧表示します。
GET /api/v1/repository/{repository}/trigger/
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |