pipelines

get steps for given service definition type

Request
Security:
ApiKey (readwrite)
query Parameters
serviceDefinitionType
required
string
Value: "Kubernetes"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/steps
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/pipelines/configuration/steps?serviceDefinitionType=Kubernetes' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Execution Strategy list

Request
Security:
ApiKey (readwrite)
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/strategies
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/ng/api/pipelines/configuration/strategies \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Yaml for Execution Strategy based on deployment type and selected strategy

Request
Security:
ApiKey (readwrite)
query Parameters
serviceDefinitionType
required
string
Value: "Kubernetes"
strategyType
required
string
Enum: "Basic" "Canary" "BlueGreen" "Rolling" "Default"
includeVerify
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/strategies/yaml-snippets
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/pipelines/configuration/strategies/yaml-snippets?serviceDefinitionType=Kubernetes&strategyType=Basic&includeVerify=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": "string",
  • "metaData": { },
  • "correlationId": "string"
}

Gets Yaml for Execution Strategy based on Provisioner Type

Request
Security:
ApiKey (readwrite)
query Parameters
provisionerType
required
string
Enum: "TERRAFORM" "CLOUD_FORMATION" "AZURE_ARM" "SHELL_SCRIPT_PROVISIONER"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/strategies/provisioner-yaml-snippets
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/pipelines/configuration/strategies/provisioner-yaml-snippets?provisionerType=TERRAFORM' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": "string",
  • "metaData": { },
  • "correlationId": "string"
}

Git list of service definition types

Request
Security:
ApiKey (readwrite)
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/serviceDefinitionTypes
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/ng/api/pipelines/configuration/serviceDefinitionTypes \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": [
    ],
  • "metaData": { },
  • "correlationId": "string"
}

get provisioner steps

Request
Security:
ApiKey (readwrite)
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/pipelines/configuration/provisioner-steps
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/ng/api/pipelines/configuration/provisioner-steps \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get pipeline health

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
moduleInfo
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/pipelines/pipelineHealth
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/pipelineHealth?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&moduleInfo=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get pipeline execution

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
moduleInfo
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/pipelines/pipelineExecution
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/pipelineExecution?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&moduleInfo=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets a pipeline by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
pipelineIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/pipelines/{pipelineIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/:pipelineIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a Pipeline

Request
Security:
ApiKey (readwrite)
path Parameters
pipelineIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
baseBranch
string
header Parameters
If-Match
string
Request Body schema:
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/pipelines/{pipelineIdentifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "data": "string",
  • "metaData": { },
  • "correlationId": "string"
}

Delete a pipeline

Request
Security:
ApiKey (readwrite)
path Parameters
pipelineIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
header Parameters
If-Match
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/pipeline/api/pipelines/{pipelineIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/pipeline/api/pipelines/:pipelineIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&branch=string&repoIdentifier=string&rootFolder=string&filePath=string&commitMsg=string&lastObjectId=string' \
  -H 'If-Match: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Gets Pipeline list

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 25
sort
Array of strings
searchTerm
string
module
string
filterIdentifier
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
getDistinctFromBranches
boolean
Request Body schema:
object
filterType
string
connectorNames
Array of strings
connectorIdentifiers
Array of strings
description
string
types
Array of strings
Items Enum: "K8sCluster" "Git" "Splunk" "AppDynamics" "Prometheus" "Dynatrace" "Vault" "AzureKeyVault" "DockerRegistry" "Local" "AwsKms" "GcpKms" "AwsSecretManager" "Gcp" "Aws" "Artifactory" "Jira" "Nexus" "Github" "Gitlab" "Bitbucket" "Codecommit" "CEAws" "CEAzure" "GcpCloudCost" "CEK8sCluster" "HttpHelmRepo" "NewRelic" "Datadog" "SumoLogic" "PagerDuty"
categories
Array of strings
Items Enum: "CLOUD_PROVIDER" "SECRET_MANAGER" "CLOUD_COST" "ARTIFACTORY" "CODE_REPO" "MONITORING" "TICKETING"
connectivityStatuses
Array of strings
Items Enum: "SUCCESS" "FAILURE" "PARTIAL" "UNKNOWN"
inheritingCredentialsFromDelegate
boolean
object (CcmConnectorFilter)
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/pipelines/list
Request samples
{
  • "tags": {
    },
  • "filterType": "ConnectorFilterProperties",
  • "connectorNames": [
    ],
  • "connectorIdentifiers": [
    ],
  • "description": "string",
  • "types": [
    ],
  • "categories": [
    ],
  • "connectivityStatuses": [
    ],
  • "inheritingCredentialsFromDelegate": true,
  • "ccmConnectorFilter": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Pipeline Summary of a pipeline

Request
Security:
ApiKey (readwrite)
path Parameters
pipelineIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/pipelines/summary/{pipelineIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/summary/:pipelineIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Executions list

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
searchTerm
string
pipelineIdentifier
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 10
sort
Array of strings
filterIdentifier
string
module
string
status
Array of strings
Items Enum: "Running" "AsyncWaiting" "TaskWaiting" "TimedWaiting" "Failed" "Errored" "IgnoreFailed" "NotStarted" "Expired" "Aborted" "Discontinuing" "Queued" "Paused" "ResourceWaiting" "InterventionWaiting" "ApprovalWaiting" "Success" "Suspended" "Skipped" "Pausing" "ApprovalRejected" "NOT_STARTED" "INTERVENTION_WAITING" "APPROVAL_WAITING" "APPROVAL_REJECTED" "WAITING"
myDeployments
boolean
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Request Body schema:
object
filterType
string
connectorNames
Array of strings
connectorIdentifiers
Array of strings
description
string
types
Array of strings
Items Enum: "K8sCluster" "Git" "Splunk" "AppDynamics" "Prometheus" "Dynatrace" "Vault" "AzureKeyVault" "DockerRegistry" "Local" "AwsKms" "GcpKms" "AwsSecretManager" "Gcp" "Aws" "Artifactory" "Jira" "Nexus" "Github" "Gitlab" "Bitbucket" "Codecommit" "CEAws" "CEAzure" "GcpCloudCost" "CEK8sCluster" "HttpHelmRepo" "NewRelic" "Datadog" "SumoLogic" "PagerDuty"
categories
Array of strings
Items Enum: "CLOUD_PROVIDER" "SECRET_MANAGER" "CLOUD_COST" "ARTIFACTORY" "CODE_REPO" "MONITORING" "TICKETING"
connectivityStatuses
Array of strings
Items Enum: "SUCCESS" "FAILURE" "PARTIAL" "UNKNOWN"
inheritingCredentialsFromDelegate
boolean
object (CcmConnectorFilter)
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/pipelines/execution/summary
Request samples
{
  • "tags": {
    },
  • "filterType": "ConnectorFilterProperties",
  • "connectorNames": [
    ],
  • "connectorIdentifiers": [
    ],
  • "description": "string",
  • "types": [
    ],
  • "categories": [
    ],
  • "connectivityStatuses": [
    ],
  • "inheritingCredentialsFromDelegate": true,
  • "ccmConnectorFilter": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Execution Detail

Request
Security:
ApiKey (readwrite)
path Parameters
planExecutionId
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
filter
string
stageNodeId
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/pipelines/execution/{planExecutionId}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/execution/:planExecutionId?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&filter=string&stageNodeId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {