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