Chapter 24. trigger

24.1. activateBuildTrigger
Copiar enlace

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 '{

$ 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
Copiar enlace

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
Copiar enlace

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 '{

$ 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
Copiar enlace

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
Copiar enlace

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
Copiar enlace

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
Copiar enlace

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

Este contenido no está disponible en el idioma seleccionado.

24.1. activateBuildTriggerCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Request body schema (application/json)

Responses

Example command

24.2. listTriggerRecentBuildsCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Query parameters

Responses

Example command

24.3. manuallyStartBuildTriggerCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Request body schema (application/json)

Responses

Example command

24.4. getBuildTriggerCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

24.5. updateBuildTriggerCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Request body schema (application/json)

Responses

Example command

24.6. deleteBuildTriggerCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

24.7. listBuildTriggersCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Hacer que el código abierto sea más inclusivo

Acerca de Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

24.1. activateBuildTrigger
Copiar enlace

24.2. listTriggerRecentBuilds
Copiar enlace

24.3. manuallyStartBuildTrigger
Copiar enlace

24.4. getBuildTrigger
Copiar enlace

24.5. updateBuildTrigger
Copiar enlace

24.6. deleteBuildTrigger
Copiar enlace

24.7. listBuildTriggers
Copiar enlace