REST API

What you need to do is execute the Resource URL (below) and send to it POST Param to_revision.

http
POST /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/executions

URL Parameters

NameTypeDescription
domain RequiredStringThe workspace domain.
pipeline_id RequiredIntegerThe numerical ID of the desired scenario.
project_name RequiredStringThe name ID of the project.

POST Parameters

NameTypeDescription
to_revision RequiredObjectThe object containing the revision field in which a revision or HEAD will be provided from the repository that will be executed in the pipeline.
variablesVariable[]The list of variables to set as parameters for the pipeline.
branchObjectThe object containing the name field with the name of the branch to be executed when a pipeline has multiple refs or one of the refs is a wildcard.
tagObjectThe object containing the name field with the name of the tag to be executed when a pipeline has multiple refs or one of the refs is a wildcard.
commentStringExecution comment.
refreshBooleanDeploy from scratch.
clear_cacheBooleanClear cache before running the pipeline.
priorityStringExecution priority. Can be one of LOW, NORMAL or HIGH. Default is NORMAL.
actions_to_runInteger[]Send the actions' IDs list to be run in this execution. If not sent, it will be run in accordance with the pipeline's definition.
delay_untiliso 8601 utc dateThe date when the execution should be run. Should be set in the format: 2016-11-18T12:38:16.000Z.
pull_requestObjectThe object containing the name field with the name of the pull request to be executed when a pipeline has multiple refs or one of the refs is a wildcard.
Last update:
Sep 23, 2024