Chapter 24. trigger

24.1. activateBuildTrigger
复制链接

Activate the specified build trigger.

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Expand

Name	Description	Schema
config required	Arbitrary json.	object
pull_robot optional	The name of the robot that will be used to pull images.	string

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/activate" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "branch": "main"
    },
    "pull_robot": "example+robot"
  }'

$ curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/activate" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "branch": "main"
    },
    "pull_robot": "example+robot"
  }'

Copy to Clipboard

Toggle word wrap

24.2. listTriggerRecentBuilds
复制链接

List the builds started by the specified trigger.

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

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	limit optional	The maximum number of builds to return	integer

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/builds?limit=10" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/builds?limit=10" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

24.3. manuallyStartBuildTrigger
复制链接

Manually start a build from the specified trigger.

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Optional run parameters for activating the build trigger

Expand

Name	Description	Schema
branch_name optional	(SCM only) If specified, the name of the branch to build.	string
commit_sha optional	(Custom Only) If specified, the ref/SHA1 used to checkout a git repository.	string
refs optional	(SCM Only) If specified, the ref to build.

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/start" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "branch_name": "main",
    "commit_sha": "abcdef1234567890",
    "refs": "refs/heads/main"
  }'

$ curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/start" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "branch_name": "main",
    "commit_sha": "abcdef1234567890",
    "refs": "refs/heads/main"
  }'

Copy to Clipboard

Toggle word wrap

24.4. getBuildTrigger
复制链接

Get information for the specified build trigger.

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

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

24.5. updateBuildTrigger
复制链接

Updates the specified build trigger.

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

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Options for updating a build trigger

Expand

Name	Description	Schema
enabled required	Whether the build trigger is enabled	boolean

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X PUT "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

$ curl -X PUT "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

Copy to Clipboard

Toggle word wrap

24.6. deleteBuildTrigger
复制链接

Delete the specified build trigger.

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

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	trigger_uuid required	The UUID of the build trigger	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X DELETE "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X DELETE "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

24.7. listBuildTriggers
复制链接

List the triggers for the specified repository.

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

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

此内容没有您所选择的语言版本。

24.1. activateBuildTrigger复制链接链接已复制到粘贴板!

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate

Path parameters

Request body schema (application/json)

Responses

Example command

24.2. listTriggerRecentBuilds复制链接链接已复制到粘贴板!

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

Path parameters

Query parameters

Responses

Example command

24.3. manuallyStartBuildTrigger复制链接链接已复制到粘贴板!

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

Path parameters

Request body schema (application/json)

Responses

Example command

24.4. getBuildTrigger复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

24.5. updateBuildTrigger复制链接链接已复制到粘贴板!

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

Path parameters

Request body schema (application/json)

Responses

Example command

24.6. deleteBuildTrigger复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

24.7. listBuildTriggers复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

24.1. activateBuildTrigger
复制链接

24.2. listTriggerRecentBuilds
复制链接

24.3. manuallyStartBuildTrigger
复制链接

24.4. getBuildTrigger
复制链接

24.5. updateBuildTrigger
复制链接

24.6. deleteBuildTrigger
复制链接

24.7. listBuildTriggers
复制链接