Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Pipeline Execution

Execute Published Pipeline

Triggers the asynchronous execution of a named, published pipeline within the specified project.

The pipeline must be published to the target environment before it can be executed. On success, returns a pipelineExecutionId that can be used to track or query the execution status.

Key behaviours:

  • By default, the latest published version of the pipeline is executed. Use versionName to target a specific artifact version.
  • If no agentId is provided, the default agent configured for the target environment is used.
  • Use executionTag to control concurrency — only one execution per tag is permitted to run at a time within a given environment. A 409 Conflict is returned if an execution with the same tag is already in progress.
  • Runtime variable values can be overridden per-execution using scalarVariables (key-value pairs) or gridVariables (two-dimensional string arrays), without modifying the published pipeline definition.
  • A 410 Gone is returned if the pipeline has been disabled.
post/v1/projects/{projectId}/pipeline-executions

Path parameters

projectIdstring uuid required

Request body

agentIdstring

Optional agentId to execute the pipeline. If not specified the default agent for the provided environment will be used

environmentNamestring required

Environment pipeline is published to

executionTagstring

Optional execution tag, this allows control of pipeline execution concurrency. Only 1 pipeline execution is allowed to run per execution tag in a given environment.

gridVariablesobject

Optional map of grid variable names to two-dimensional string arrays, used to override grid variable values for this execution without modifying the published pipeline definition

pipelineNamestring required

Name of the pipeline to execute

scalarVariablesobject

Optional map of scalar variable names to their override values for this execution, without modifying the published pipeline definition

versionNamestring

Optional artifact version name of the pipeline to execute. If not specified the latest version will be executed

Example request

{
  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "environmentName": "Dev Env",
  "executionTag": "tag1",
  "pipelineName": "My pipeline",
  "versionName": "1.1.0"
}

Response

Pipeline executed

pipelineExecutionIdstring uuid

Identifier of executing pipeline

Example response

{
  "pipelineExecutionId": "1398aa31-af57-4a6a-9752-27c2e8556c3f"
}