Chapter 29. trigger
Create, list and manage build triggers.
29.1. activateBuildTrigger
Activate the specified build trigger.
29.1.1. POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
Authorizations: oauth2_implicit (repo:admin)
29.1.2. Path parameters
| 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 |
29.1.3. Request body schema (application/json)
| Name | Description | Schema |
|---|---|---|
| config required | Arbitrary json. | object |
| pull_robot optional | The name of the robot that will be used to pull images. | string |
29.1.4. Responses
29.1.5. 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"
}'29.2. listTriggerRecentBuilds
List the builds started by the specified trigger.
29.2.1. GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
Authorizations: oauth2_implicit (repo:admin)
29.2.2. Path parameters
| 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 |
29.2.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | limit optional | The maximum number of builds to return | integer |
29.2.4. Responses
29.2.5. 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>"29.3. manuallyStartBuildTrigger
Manually start a build from the specified trigger.
29.3.1. POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
Authorizations: oauth2_implicit (repo:admin)
29.3.2. Path parameters
| 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 |
29.3.3. Request body schema (application/json)
Optional run parameters for activating the build trigger
| 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. |
29.3.4. Responses
29.3.5. 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"
}'29.4. getBuildTrigger
Get information for the specified build trigger.
29.4.1. GET /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit (repo:admin)
29.4.2. Path parameters
| 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 |
29.4.3. Responses
29.4.4. 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>"29.5. updateBuildTrigger
Updates the specified build trigger.
29.5.1. PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit (repo:admin)
29.5.2. Path parameters
| 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 |
29.5.3. Request body schema (application/json)
Options for updating a build trigger
| Name | Description | Schema |
|---|---|---|
| enabled required | Whether the build trigger is enabled | boolean |
29.5.4. Responses
29.5.5. 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}'29.6. deleteBuildTrigger
Delete the specified build trigger.
29.6.1. DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit (repo:admin)
29.6.2. Path parameters
| 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 |
29.6.3. Responses
29.6.4. 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>"29.7. listBuildTriggers
List the triggers for the specified repository.
29.7.1. GET /api/v1/repository/{repository}/trigger/
Authorizations: oauth2_implicit (repo:admin)
29.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
29.7.3. Responses
29.7.4. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/" \
-H "Authorization: Bearer <your_access_token>"
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}