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

要求の body スキーマ (application/json)
名前説明スキーマ

config
任意

任意の json

object

pull_robot
任意

イメージのプルに使用するロボットの名前

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

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
任意

返すビルドの最大数

integer

応答
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

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

要求の body スキーマ (application/json)

ビルドトリガーをアクティベートするための実行パラメーター (任意)

名前説明スキーマ

branch_name
任意

(SCM のみ) 指定した場合のビルドするブランチの名前。

string

commit_sha
任意

(カスタムのみ) 指定されている場合は、git リポジトリーのチェックアウトに使用する ref/SHA1。

string

refs
任意

(SCM のみ) 指定されている場合のビルドの ref。

 
応答
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

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

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.5. updateBuildTrigger

指定したビルドトリガーを更新します。

PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

trigger_uuid
必須

ビルドトリガーの UUID

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

要求の body スキーマ (application/json)

ビルドトリガーを更新するオプション

名前説明スキーマ

enabled
任意

ビルドトリガーが有効かどうか

boolean

応答
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.6. 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

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.23.7. listBuildTriggers

指定したリポジトリーのトリガーを一覧表示します。

GET /api/v1/repository/{repository}/trigger/

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError