Pipelines [Beta]

This contains APIs for performing CRUD operations on Pipelines.

List Pipelines

Returns a list of Pipelines.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier

query Parameters

page	integer Default: 0 Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.
limit	integer <= 100 Default: 30 Pagination: Number of items to return.
search_term	string This would be used to filter resources having attributes matching the search term.
sort	string Parameter on the basis of which sorting is done. Enum: "name" "updated"
order	string Order on the basis of which sorting is done. Enum: "ASC" "DESC"
module	string Harness module which is part of the Pipeline. Enum: "CD" "CI" "CV" "CF" "CE" "STO"
filter_identifier	string Identifier of a saved Filter.
pipeline_identifiers	Array of strings List of Pipeline identifiers on the basis of which the Pipelines are filtered.
name	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ Pipeline Name on the basis of which the Pipelines are filtered.
description	string <= 1024 characters Pipeline Description on the basis of which the Pipelines are filtered.
tags	Array of strings <= 128 items Filter tags as a key:value pair. Examples: Tag having both Key and Value. tags=key:value Tag having only Key. tags=key
service_names	Array of strings Service names on the basis of which the Pipelines are filtered. [CD]
env_names	Array of strings Names of Environments on the basis of which the Pipelines are filtered. [CD]
deployment_type	string Deployment type on the basis of which the Pipelines are filtered. [CD]
repository	string Repository name on the basis of which the Pipelines are filtered. [CI]

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

200

Response body for List Pipelines.

get/v1/orgs/{org}/projects/{project}/pipelines

Request samples

curl
Java
Go

Response samples

[{"identifier": "example_pipeline",
"name": "Example Pipeline",
"description": "This is an Example Pipeline",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"created": 1234567890,
"updated": 1234567890,
"modules": ["CD"
],
"recent_execution_info": [{"executor_info": {"trigger_type": "NOOP",
"username": "harness_user",
"email": "noreply@harness.io"
},
"execution_id": "example_execution_identifier",
"execution_status": "Running",
"started": 1234567890,
"ended": 1234567890,
"run_number": 5,
"parent_stage_info": {"has_parent_pipeline": true,
"execution_id": "example_parent_execution_identifier",
"identifier": "example_parent_pipeline_id",
"project_id": "example_project_id",
"org_id": "example_org_id",
"run_sequence": 12671687,
"stage_node_id": "example_stage_node_id"
}
}
],
"store_type": "REMOTE",
"connector_ref": "example_connector",
"valid": true,
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
}
}
]

Create a Pipeline

Creates a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema:
application/json
required

Pipeline request body

pipeline_yaml required	string Pipeline YAML (to be passed as a String).
identifier required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$ Pipeline identifier
name required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ Pipeline name
description	string <= 1024 characters Pipeline description
	object <= 128 properties Pipeline tags
	object (Create Git Details) Contains parameters related to creating an Entity for Git Experience.

Responses

201

Pipeline response body

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

Request samples

Payload
curl
Java
Go

{"pipeline_yaml": "pipeline:\n  identifier: example_pipeline\n  name: ExamplePipeline\n  allowStageExecutions: false\n  stages:\n    - stage:\n        name: Example Build Stage\n        identifier: example_build_stage\n        description: ''\n        type: Approval\n        spec:\n          execution:\n            steps:\n              - step:\n                  name: Approval Step\n                  identifier: Approval_Step\n                  type: HarnessApproval\n                  timeout: 1d\n                  spec:\n                    approvalMessage: |-\n                      Please review the following information\n                      and approve the pipeline progression\n                    includePipelineExecutionHistory: true\n                    approvers:\n                      minimumCount: 1\n                      disallowPipelineExecutor: false\n                      userGroups: <+input>\n                    approverInputs: []\n              - step:\n                  type: ShellScript\n                  name: ShellScript Step\n                  identifier: ShellScript_Step\n                  spec:\n                    shell: Bash\n                    onDelegate: true\n                    source:\n                      type: Inline\n                      spec:\n                        script: <+input>\n                    environmentVariables: []\n                    outputVariables: []\n                    executionTarget: {}\n                  timeout: 10m\n        tags: {}\n    - stage:\n        name: Example Deploy Stage\n        identifier: example_deploy_stage\n        description: ''\n        type: Deployment\n        spec:\n          serviceConfig:\n            serviceRef: <+input>\n            serviceDefinition:\n              spec:\n                variables: []\n              type: Kubernetes\n          infrastructure:\n            environmentRef: <+input>\n            infrastructureDefinition:\n              type: KubernetesDirect\n              spec:\n                connectorRef: <+input>\n                namespace: <+input>\n                releaseName: release-<+INFRA_KEY>\n            allowSimultaneousDeployments: false\n          execution:\n            steps:\n              - step:\n                  name: Rollout Deployment\n                  identifier: rolloutDeployment\n                  type: K8sRollingDeploy\n                  timeout: 10m\n                  spec:\n                    skipDryRun: false\n            rollbackSteps:\n              - step:\n                  name: Rollback Rollout Deployment\n                  identifier: rollbackRolloutDeployment\n                  type: K8sRollingRollback\n                  timeout: 10m\n                  spec: {}\n        tags: {}\n        failureStrategies:\n          - onFailure:\n              errors:\n                - AllErrors\n              action:\n                type: StageRollback\n",
"identifier": "example_pipeline",
"name": "ExamplePipeline",
"description": "Pipeline Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"branch_name": "branch",
"file_path": "/folder/file.json",
"commit_message": "Added Harness Git Experience",
"base_branch": "old_branch",
"connector_ref": "git_connector",
"store_type": "REMOTE",
"repo_name": "example_repository"
}
}

Response samples

{"identifier": "example_pipeline"
}

Retrieve a Pipeline

Retrieves a Pipeline.

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).
template_applied	boolean Default: false If true, returns Pipeline YAML with Templates applied on it.
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).
load_from_fallback_branch	boolean Default: false Flag to load the pipeline from the created non default branch
validate_async	boolean Default: "false" Flag to tell whether to start an asynchronous validation process or not

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

Pipeline response body

get/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}

Request samples

curl
Java
Go

Response samples

{"pipeline_yaml": "example_yaml_text",
"template_applied_pipeline_yaml": "example_yaml_text_with_template",
"identifier": "example_pipeline",
"name": "ExamplePipeline",
"org": "example_org",
"project": "example_project",
"description": "Pipeline Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"modules": ["cd"
],
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
},
"valid": true,
"yaml_error_wrapper": {"message": "something is incorrect",
"message_fqn": "something is incorrect at pipeline.name",
"stage_info": {"identifier": "example_stage",
"type": "stage",
"name": "Example Stage",
"fqn": "pipeline.stages.stage"
},
"step_info": {"identifier": "example_step",
"type": "string",
"name": "string",
"fqn": "pipeline.steps.step"
},
"fqn": "pipeline.name",
"hint_message": "try changing something"
},
"cache_response_metadata": {"cache_state": "VALID_CACHE",
"ttl_left": 9223372036854776000,
"last_updated_at": 9223372036854776000
},
"created": 1234567890,
"updated": 1234567890
}

Update a Pipeline

Updates a Pipeline.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema:
application/json
required

Pipeline request body

pipeline_yaml required	string Pipeline YAML (to be passed as a String).
identifier required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$ Pipeline identifier
name required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ Pipeline name
description	string <= 1024 characters Pipeline description
	object <= 128 properties Pipeline tags
	object (Update Git Details) Contains parameters related to updating an Entity for Git Experience.

Responses

200

Pipeline response body

put/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}

Request samples

Payload
curl
Java
Go

{"pipeline_yaml": "pipeline:\n  identifier: example_pipeline\n  name: ExamplePipeline\n  allowStageExecutions: false\n  stages:\n    - stage:\n        name: Example Build Stage\n        identifier: example_build_stage\n        description: ''\n        type: Approval\n        spec:\n          execution:\n            steps:\n              - step:\n                  name: Approval Step\n                  identifier: Approval_Step\n                  type: HarnessApproval\n                  timeout: 1d\n                  spec:\n                    approvalMessage: |-\n                      Please review the following information\n                      and approve the pipeline progression\n                    includePipelineExecutionHistory: true\n                    approvers:\n                      minimumCount: 1\n                      disallowPipelineExecutor: false\n                      userGroups: <+input>\n                    approverInputs: []\n              - step:\n                  type: ShellScript\n                  name: ShellScript Step\n                  identifier: ShellScript_Step\n                  spec:\n                    shell: Bash\n                    onDelegate: true\n                    source:\n                      type: Inline\n                      spec:\n                        script: <+input>\n                    environmentVariables: []\n                    outputVariables: []\n                    executionTarget: {}\n                  timeout: 10m\n        tags: {}\n    - stage:\n        name: Example Deploy Stage\n        identifier: example_deploy_stage\n        description: ''\n        type: Deployment\n        spec:\n          serviceConfig:\n            serviceRef: <+input>\n            serviceDefinition:\n              spec:\n                variables: []\n              type: Kubernetes\n          infrastructure:\n            environmentRef: <+input>\n            infrastructureDefinition:\n              type: KubernetesDirect\n              spec:\n                connectorRef: <+input>\n                namespace: <+input>\n                releaseName: release-<+INFRA_KEY>\n            allowSimultaneousDeployments: false\n          execution:\n            steps:\n              - step:\n                  name: Rollout Deployment\n                  identifier: rolloutDeployment\n                  type: K8sRollingDeploy\n                  timeout: 10m\n                  spec:\n                    skipDryRun: false\n            rollbackSteps:\n              - step:\n                  name: Rollback Rollout Deployment\n                  identifier: rollbackRolloutDeployment\n                  type: K8sRollingRollback\n                  timeout: 10m\n                  spec: {}\n        tags: {}\n        failureStrategies:\n          - onFailure:\n              errors:\n                - AllErrors\n              action:\n                type: StageRollback\n",
"identifier": "example_pipeline",
"name": "ExamplePipeline",
"description": "Pipeline Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"branch_name": "branch",
"commit_message": "Added Harness Git Experience",
"last_object_id": "abcdXYZ",
"base_branch": "old_branch",
"last_commit_id": "abcdXYZ",
"connector_ref": "git_connector",
"store_type": "REMOTE",
"repo_name": "example_repository"
}
}

Response samples

{"identifier": "example_pipeline"
}

Delete a Pipeline

Deletes a Pipeline.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

204

No Content

400

Bad Request

delete/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}

Request samples

curl
Java
Go

Response samples

{ }

Patch API for pipeline

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

pipeline_yaml	string Pipeline YAML (to be passed as a String).
name	string Pipeline Name.
desc	string Pipeline Description.
	object <= 128 properties Pipeline Tags.
	object (Update Git Details) Contains parameters related to updating an Entity for Git Experience.
version	string Version of pipeline yaml, should be one of "0" or "1"

Responses

200

Pipeline response body

patch/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}

Request samples

Payload
curl
Java
Go

application/json

{"pipeline_yaml": "string",
"name": "string",
"desc": "string",
"tags": {"property1": "string",
"property2": "string"
},
"git_details": {"branch_name": "string",
"commit_message": "string",
"last_object_id": "string",
"base_branch": "string",
"last_commit_id": "string",
"connector_ref": "string",
"store_type": "INLINE",
"repo_name": "string",
"file_path": "string"
},
"version": "string"
}

Response samples

{"identifier": "example_pipeline"
}

Move Pipeline YAML from inline to remote

Creates a remote entity by fetching pipeline YAML from Harness.

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

	object (Move Git Details) Parameters related to moving an entity for Git Experience.
pipeline_identifier	string
move_config_operation_type	string (MoveConfigOperationType) Operation type to move the configuration Value: "INLINE_TO_REMOTE"

Responses

200

Response body for moving a pipeline configuration.

post/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config

Request samples

Payload
curl
Java
Go

application/json

{"git_details": {"branch_name": "string",
"file_path": "string",
"commit_message": "string",
"base_branch": "string",
"connector_ref": "string",
"repo_name": "string"
},
"pipeline_identifier": "string",
"move_config_operation_type": "INLINE_TO_REMOTE"
}

Response samples

application/json

{"pipeline_identifier": "string"
}

Get Pipeline YAML from Git Repository

Fetches Pipeline YAML from Git Repository and saves a record for it in Harness

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

Pipeline import request body

	object (Import Git Information) Parameters related to importing an entity for Git.
	object (Pipeline Import Request DTO) Information of Pipeline import request DTO

Responses

200

Response body for pipeline save.

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

Request samples

Payload
curl
Java
Go

application/json

{"git_import_info": {"connector_ref": "string",
"repo_name": "string",
"branch_name": "string",
"file_path": "string",
"is_force_import": true
},
"pipeline_import_request": {"pipeline_name": "string",
"pipeline_description": "string"
}
}

Response samples

application/json

{"identifier": "string",
"governance_metadata": [{"identifier": "string",
"deny": true,
"policy_set_metadata": [{"policy_set_identifier": "string",
"deny": true,
"policy_metadata": [{"policy_identifier": "string",
"policy_name": "string",
"severity": "string",
"deny_messages": [null
],
"status": "string",
"identifier": "string",
"account_identifier": "string",
"org_identifier": "string",
"project_identifier": "string",
"created": 0,
"updated": 0,
"error": "string"
}
],
"policy_set": "string",
"status": "string",
"identifier": "string",
"created": 0,
"account_identifier": "string",
"org_identifier": "string",
"project_identifier": "string"
}
],
"message": "string",
"time_stamp": 0,
"status": "string",
"account_identifier": "string",
"org_identifier": "string",
"project_identifier": "string",
"entity": "string",
"type": "string",
"action": "string",
"created": 0
}
]
}

Update GitMetadata for Remote Pipelines

Update git-metadata in remote pipeline

Securityx-api-key

Request

path Parameters

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

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

connector_ref	string Harness connector id used for entity CRUD operations
repo_name	string Name of the repository.
file_path	string File path of the entity in the repository.

Responses

200

Example response

put/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata

Request samples

Payload
curl
Java
Go

application/json

{"connector_ref": "string",
"repo_name": "string",
"file_path": "string"
}

Response samples

application/json

{"entity_identifier": "string"
}

➔ Next to Input Sets [Beta]

Pipelines [Beta]

List Pipelines

path Parameters

query Parameters

header Parameters

Create a Pipeline

path Parameters

header Parameters

Request Body schema: application/jsonapplication/yamlapplication/jsonrequired

Retrieve a Pipeline

path Parameters

query Parameters

header Parameters

Update a Pipeline

path Parameters

header Parameters

Request Body schema: application/jsonapplication/yamlapplication/jsonrequired

Delete a Pipeline

path Parameters

header Parameters

Patch API for pipeline

path Parameters

header Parameters

Request Body schema: application/json

Move Pipeline YAML from inline to remote

path Parameters

header Parameters

Request Body schema: application/json

Get Pipeline YAML from Git Repository

path Parameters

header Parameters

Request Body schema: application/json

Update GitMetadata for Remote Pipelines

path Parameters

header Parameters

Request Body schema: application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required