Pipeline Execution [Beta]

This contains APIs for Pipeline Execution.

Execute Pipeline

Pipeline Execution API

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
pipeline required	string Pipeline identifier

query Parameters

module	string Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI
use_fqn_if_error_response	boolean Default: "false" Use FQN in error response.
notify_only_user	boolean Default: "false"
notes	string Notes of a pipeline execution
branch_name	string Name of the branch (for Git Experience).
connector_ref	string Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience).
repo_name	string Name of the repository (for Git Experience).

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

inputs_yaml

string

Inputs YAML if the Pipeline contains Runtime Inputs

Responses

200

Example response

post/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute

Request samples

Payload
curl
Java
Go

application/json

{"inputs_yaml": "string"
}

Response samples

application/json

{"execution_details": {"execution_id": "string",
"status": "string"
}
}

Get Stages execution List for a given Pipeline execution.

Returns list of Stage identifiers with their names and stage dependencies

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
pipeline required	string Pipeline identifier

query Parameters

branch_name	string Name of the branch (for Git Experience).
connector_ref	string Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience).
repo_name	string Name of the repository (for Git Experience).

header Parameters

Harness-Account	string Identifier field of the account the resource is scoped to.
Load-From-Cache	string Default: false Flag to enable loading the remote Pipeline from git or git cache

Responses

200

Example response

get/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages-execution-list

Request samples

curl
Java
Go

curl -i -X GET \
  'https://app.harness.io/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages-execution-list?branch_name=string&connector_ref=string&repo_name=string' \
  -H 'Harness-Account: string' \
  -H 'Load-From-Cache: false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Re-run Stages Execution of a Pipeline

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
pipeline required	string Pipeline identifier
execution-id required	string Pipeline Execution identifier

query Parameters

branch_name	string Name of the branch (for Git Experience).
connector_ref	string Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience).
repo_name	string Name of the repository (for Git Experience)
use_fqn_if_error	boolean Default: false Use FQN in error response
module	string Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI.
notes	string Notes of a pipeline execution

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

inputs_yaml	string Inputs yaml of the Pipeline.
stage_identifiers	Array of strings List of stages to run.
	object If any selected stage to execute has expressions, then this map contains expressions with its corresponding values.

Responses

200

Example response

post/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}/stages

Request samples

Payload
curl
Java
Go

application/json

{"inputs_yaml": "string",
"stage_identifiers": ["string"
],
"expression_values": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

{"execution_details": {"execution_id": "string",
"status": "string"
}
}

Execute given Stages of a Pipeline

Execute given Stages of a Pipeline with Input Yaml

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
pipeline required	string Pipeline identifier

query Parameters

module	string Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI.
use_fqn_if_error	string Default: "false" Use FQN in error response.
notes	string Notes of a Pipeline execution.
branch_name	string Name of the branch (for Git Experience).
connector_ref	string Identifier of the Harness Connector used for CRUD operations on the Entity (for Git Experience).
repo_name	string Name of the repository (for Git Experience).

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

inputs_yaml	string Inputs yaml of the Pipeline.
stage_identifiers	Array of strings List of stages to run.
	object If any selected stage to execute has expressions, then this map contains expressions with its corresponding values.

Responses

200

Example response

post/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages

Request samples

Payload
curl
Java
Go

application/json

{"inputs_yaml": "string",
"stage_identifiers": ["string"
],
"expression_values": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

{"execution_details": {"execution_id": "string",
"status": "string"
}
}

➔ Next to Pipeline Dashboard