Harness

Git Sync

Contains APIs for CRUD on Git Sync

Lists Git Sync Config for the given scope

Securityx-api-key
Request
query Parameters
projectIdentifier
string

Project Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

List of Git Sync Config for the given scope

get/ng/api/git-sync
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update existing Git Sync Config by Identifier
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: 
required
Details of Git Sync Config


identifier
required
string
Git Sync Config Id.


 
name
required
string
Name of the repository. Any leading/trailing spaces will be removed.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
gitConnectorRef
required
string
Id of the Connector referenced in Git


 
repo
required
string
URL of the repository. Any leading/trailing spaces will be removed.


 
branch
required
string
Name of the branch. Any leading/trailing spaces will be removed.


 
gitConnectorType
required
string
Connector Type


 Enum: "K8sCluster" "Git" "Splunk" "AppDynamics" "Prometheus" "Dynatrace" "Vault" "AzureKeyVault" "DockerRegistry" "Local" "AwsKms" "GcpKms" "AwsSecretManager" "Gcp" "Aws" "Azure" "Artifactory" "Jira" "Nexus" "Github" "Gitlab" "Bitbucket" "Codecommit" "CEAws" "CEAzure" "GcpCloudCost" "CEK8sCluster" "HttpHelmRepo" "NewRelic" "Datadog" "SumoLogic" "PagerDuty" "CustomHealth" "ServiceNow" "ErrorTracking" "Pdc" "AzureRepo" "Jenkins" "OciHelmRepo" "CustomSecretManager" "ElasticSearch" "GcpSecretManager" "AzureArtifacts" "Tas" "Spot" "Bamboo" "TerraformCloud" "SignalFX" "Harness" "Rancher"  
Array of objects (GitSyncFolderConfig) 
List of all Root Folder Details


 
Responses 
400
Bad Request


500
Internal Server Error


default
Updated Git Sync Config


put/ng/api/git-sync
Request samples 
{
  • "identifier": "string",
  • "name": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "gitConnectorRef": "string",
  • "repo": "string",
  • "branch": "string",
  • "gitConnectorType": "K8sCluster",
  • "gitSyncFolderConfigDTOs": [
    ]
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Creates Git Sync Config in given scope
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: 
required
Details of Git Sync Config


identifier
required
string
Git Sync Config Id.


 
name
required
string
Name of the repository. Any leading/trailing spaces will be removed.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
gitConnectorRef
required
string
Id of the Connector referenced in Git


 
repo
required
string
URL of the repository. Any leading/trailing spaces will be removed.


 
branch
required
string
Name of the branch. Any leading/trailing spaces will be removed.


 
gitConnectorType
required
string
Connector Type


 Enum: "K8sCluster" "Git" "Splunk" "AppDynamics" "Prometheus" "Dynatrace" "Vault" "AzureKeyVault" "DockerRegistry" "Local" "AwsKms" "GcpKms" "AwsSecretManager" "Gcp" "Aws" "Azure" "Artifactory" "Jira" "Nexus" "Github" "Gitlab" "Bitbucket" "Codecommit" "CEAws" "CEAzure" "GcpCloudCost" "CEK8sCluster" "HttpHelmRepo" "NewRelic" "Datadog" "SumoLogic" "PagerDuty" "CustomHealth" "ServiceNow" "ErrorTracking" "Pdc" "AzureRepo" "Jenkins" "OciHelmRepo" "CustomSecretManager" "ElasticSearch" "GcpSecretManager" "AzureArtifacts" "Tas" "Spot" "Bamboo" "TerraformCloud" "SignalFX" "Harness" "Rancher"  
Array of objects (GitSyncFolderConfig) 
List of all Root Folder Details


 
Responses 
400
Bad Request


500
Internal Server Error


default
Successfully created Git Sync Config


post/ng/api/git-sync
Request samples 
{
  • "identifier": "string",
  • "name": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "gitConnectorRef": "string",
  • "repo": "string",
  • "branch": "string",
  • "gitConnectorType": "K8sCluster",
  • "gitSyncFolderConfigDTOs": [
    ]
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Check whether Git Sync is enabled for given scope or not
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Result of whether Git Sync is enabled for the scope


get/ng/api/git-sync/git-sync-enabled
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update existing Git Sync Config default root folder by Identifier
Securityx-api-key 
Request 
path Parameters
identifier
required
string
Git Sync Config Id.


 
folderIdentifier
required
string
Folder Id


 
query Parameters
projectId
string
Project Identifier for the Entity.


 
organizationId
string
Organization Identifier for the Entity.


 
accountId
required
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Updated Git Sync Config default root folder


put/ng/api/git-sync/{identifier}/folder/{folderIdentifier}/default
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Git Sync Errors