connectors

Validate Identifier is unique

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
identifier
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

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

Get Connector Catalogue

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

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

Get Connectors statistics

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

successful operation

400

Bad Request

500

Internal server error

get/ng/api/connectors/stats
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/connectors/stats?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 Connector list

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema:
Array
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/connectors/listbyfqn
Request samples
[
  • "string"
]
Response samples
{
  • "status": "SUCCESS",
  • "data": [
    ],
  • "metaData": { },
  • "correlationId": "string"
}

Get CE Aws Connector Template URL Environment Wise

Request
Security:
ApiKey (readwrite)
query Parameters
eventsEnabled
boolean
curEnabled
boolean
optimizationEnabled
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/connectors/getceawstemplateurl
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/connectors/getceawstemplateurl?eventsEnabled=true&curEnabled=true&optimizationEnabled=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": "string",
  • "metaData": { },
  • "correlationId": "string"
}

Get All Allowed field values for Connector Type

Request
Security:
ApiKey (readwrite)
query Parameters
connectorType
required
string
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"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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

Test the connection

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
repoURL
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/connectors/testGitRepoConnection/{identifier}
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/connectors/testGitRepoConnection/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&repoURL=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Test the connection

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

successful operation

400

Bad Request

500

Internal server error

post/ng/api/connectors/testConnection/{identifier}
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/connectors/testConnection/:identifier?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"
}

Get Connector

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

successful operation

400

Bad Request

500

Internal server error

get/ng/api/connectors/{identifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/connectors/:identifier?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"
}

Delete a connector by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

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

Gets Connector listDeprecated

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
searchTerm
string
type
string
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"
category
string
Enum: "CLOUD_PROVIDER" "SECRET_MANAGER" "CLOUD_COST" "ARTIFACTORY" "CODE_REPO" "MONITORING" "TICKETING"
source_category
string
Enum: "CLOUD_PROVIDER" "SECRET_MANAGER" "CLOUD_COST" "ARTIFACTORY" "CODE_REPO" "MONITORING" "TICKETING"
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/connectors
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/connectors?pageIndex=0&pageSize=100&accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&searchTerm=string&type=K8sCluster&category=CLOUD_PROVIDER&source_category=CLOUD_PROVIDER&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Updates a Connector

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
baseBranch
string
Request Body schema:
object (ConnectorInfoDTO)
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/ng/api/connectors
Request samples
{
  • "connector": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Creates a Connector

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
baseBranch
string
Request Body schema:
object (ConnectorInfoDTO)
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/connectors
Request samples
{
  • "connector": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Connector list

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
string
searchTerm
string
orgIdentifier
string
projectIdentifier
string
filterIdentifier
string
includeAllConnectorsAvailableAtScope
boolean
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/ng/api/connectors/listV2
Request samples
{
  • "tags": {
    },
  • "filterType": "ConnectorFilterProperties",
  • "connectorNames": [
    ],
  • "connectorIdentifiers": [
    ],
  • "description": "string",
  • "types": [
    ],
  • "categories": [
    ],
  • "connectivityStatuses": [
    ],
  • "inheritingCredentialsFromDelegate": true,
  • "ccmConnectorFilter": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}