api-trigger-manuallyStartBuildTrigger.adoc

manuallyStartBuildTrigger

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

Authorizations: oauth2_implicit (repo:admin)

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

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.

Responses

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"
  }'