Harness

Git Full Sync

Contains APIs related to Git Full Sync

Fetch Configuration for Git Full Sync for the provided scope

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns the saved Git Full Sync Configuration for the provided scope.

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


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: 
Details of the Git Full sync Configuration


branch
required
string
Name of the branch to which the entities will be pushed and from which pull request will be created.


 
repoIdentifier
required
string
Git Sync Config Id.


 
rootFolder
required
string
Path of the root folder inside which the entities will be pushed.


 
isNewBranch
boolean
 
baseBranch
string
Name of the branch from which new branch will be forked out.


 
createPullRequest
boolean
If true a pull request will be created from branch to target branch.Default: false.


 
targetBranch
string
Name of the branch to which pull request will be merged.


 
prTitle
string
Title of the pull request.


 
newBranch
boolean
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the updated Git Full Sync Configuration for the provided scope.


put/ng/api/git-full-sync/config
Request samples 
{
  • "branch": "string",
  • "repoIdentifier": "string",
  • "rootFolder": "string",
  • "isNewBranch": true,
  • "baseBranch": "string",
  • "createPullRequest": true,
  • "targetBranch": "string",
  • "prTitle": "string",
  • "newBranch": true
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Create Configuration for Git Full Sync for the provided scope
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: 
Details of the Git Full sync Configuration


branch
required
string
Name of the branch to which the entities will be pushed and from which pull request will be created.


 
repoIdentifier
required
string
Git Sync Config Id.


 
rootFolder
required
string
Path of the root folder inside which the entities will be pushed.


 
isNewBranch
boolean
 
baseBranch
string
Name of the branch from which new branch will be forked out.


 
createPullRequest
boolean
If true a pull request will be created from branch to target branch.Default: false.


 
targetBranch
string
Name of the branch to which pull request will be merged.


 
prTitle
string
Title of the pull request.


 
newBranch
boolean
 
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the saved Configuration details for Git Full Sync.


post/ng/api/git-full-sync/config
Request samples 
{
  • "branch": "string",
  • "repoIdentifier": "string",
  • "rootFolder": "string",
  • "isNewBranch": true,
  • "baseBranch": "string",
  • "createPullRequest": true,
  • "targetBranch": "string",
  • "prTitle": "string",
  • "newBranch": true
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
List files in full sync along with their status
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
pageIndex
integer <int32> 
 Default:  0
Page Index of the results to fetch.Default Value: 0


 
pageSize
integer <int32>   <= 100 
 Default:  50
Results per page(max 100)Default Value: 50


 
Array of objects (SortOrder) 
Sort criteria for the elements.


 
pageToken
string
Page Token of the next results to fetch.Default Value: ''


 
searchTerm
string
Search Term.


 
Request Body schema: 
Entity Type and Sync Status


entityTypes
Array of strings
List of entity Types to filter on the entities.


Items Enum: "CreatePR" "MergePR" "Projects" "Pipelines" "PipelineSteps" "Http" "Email" "JiraCreate" "JiraUpdate" "JiraApproval" "HarnessApproval" "CustomApproval" "Barrier" "Queue" "FlagConfiguration" "ShellScript" "K8sCanaryDeploy" "K8sApply" "K8sBlueGreenDeploy" "K8sRollingDeploy" "K8sRollingRollback" "K8sScale" "K8sDelete" "K8sBGSwapServices" "K8sCanaryDelete" "TerraformApply" "TerraformPlan" "TerraformDestroy" "TerraformRollback" "HelmDeploy" "HelmRollback" "Connectors" "Secrets" "Files" "Service" "Environment" "EnvironmentGroup" "InputSets" "CvConfig" "Verify" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "SecurityStage" "SecuritySteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "PipelineStage" "FeatureFlagStage" "Template" "TemplateStage" "CustomDeployment" "Triggers" "MonitoredService" "GitRepositories" "FeatureFlags" "ServiceNowApproval" "ServiceNowCreate" "ServiceNowUpdate" "ServiceNowImportSet" "GovernancePolicies" "Policy" "Run" "RunTests" "Plugin" "RestoreCacheGCS" "RestoreCacheS3" "SaveCacheGCS" "SaveCacheS3" "Security" "AquaTrivy" "AWSECR" "Bandit" "BlackDuck" "Brakeman" "Burp" "Checkmarx" "Clair" "DataTheorem" "DockerContentTrust" "External" "FortifyOnDemand" "Grype" "JfrogXray" "Mend" "Metasploit" "Nessus" "NexusIQ" "Nikto" "Nmap" "Openvas" "Owasp" "PrismaCloud" "Prowler" "Qualys" "Reapsaw" "ShiftLeft" "Sniper" "Snyk" "Sonarqube" "Sysdig" "Tenable" "Veracode" "Zap" "GitClone" "ArtifactoryUpload" "GCSUpload" "S3Upload" "BuildAndPushGCR" "BuildAndPushGAR" "BuildAndPushECR" "BuildAndPushDockerRegistry" "CreateStack" "DeleteStack" "ServerlessAwsLambdaDeploy" "ServerlessAwsLambdaRollback" "CustomStage" "RollbackStack" "Infrastructure" "Command" "StrategyNode" "AzureSlotDeployment" "AzureTrafficShift" "FetchInstanceScript" "AzureSwapSlot" "AzureWebAppRollback" "JenkinsBuild" "EcsRollingDeploy" "EcsRollingRollback" "EcsCanaryDeploy" "EcsCanaryDelete" "AzureCreateARMResource" "BuildAndPushACR" "AzureCreateBPResource" "AzureARMRollback" "Background" "Wait" "ArtifactSource" "EcsBlueGreenCreateService" "EcsBlueGreenSwapTargetGroups" "EcsBlueGreenRollback" "ShellScriptProvision" "Freeze" "GitOpsUpdateReleaseRepo" "GitOpsFetchLinkedApps" "EcsRunTask" "Chaos" "ElastigroupDeploy" "ElastigroupRollback" "Action" "ElastigroupSetup" "Bitrise" "TerragruntPlan" "TerragruntApply" "TerragruntDestroy" "TerragruntRollback" "IACMStage" "IACMStep" "IACM" "Container" "IACMTerraformPlugin" "IACMApproval" "ElastigroupBGStageSetup" "ElastigroupSwapRoute" "AsgCanaryDeploy" "AsgCanaryDelete" "SwapRoutes" "SwapRollback" "AppResize" "AppRollback" "CanaryAppSetup" "BGAppSetup" "BasicAppSetup" "TanzuCommand" "AsgRollingDeploy" "AsgRollingRollback" "GovernanceRuleAWS" "TasRollingDeploy" "TasRollingRollback" "K8sDryRun" "AsgBlueGreenSwapService" "AsgBlueGreenDeploy" "AsgBlueGreenRollback" "TerraformCloudRun" "TerraformCloudRollback" "DeployCloudFunction" "DeployCloudFunctionWithNoTraffic" "CloudFunctionTrafficShift" "CloudFunctionRollback" "AwsLambdaDeploy" "AwsSamDeploy" "AwsSamRollback" "SscaOrchestration" "AwsLambdaRollback" "GitOpsSync" "BambooBuild" "CdSscaOrchestration" "RouteMapping" "AWSSecurityHub" "CustomIngest" "BackstageEnvironmentVariable" "Fossa" "CodeQL" "Gitleaks" "DeployCloudFunctionGenOne" "RollbackCloudFunctionGenOne" "K8sBlueGreenStageScaleDown" "AwsSamBuild" "Semgrep" "SscaEnforcement" "IdpConnector" "CdSscaEnforcement" "DownloadManifests" "ServerlessAwsLambdaPrepareRollbackV2" "ServerlessAwsLambdaRollbackV2" "Coverity" "ServerlessAwsLambdaDeployV2" "AnalyzeDeploymentImpact" "ServerlessAwsLambdaPackageV2" "RevertPR" "AwsCdkBootstrap" "AwsCdkSynth" "AwsCdkDiff" "AwsCdkDeploy" "AwsCdkDestroy" "IdpScorecard" "IdpCheck" "AwsCdkRollback" "SlsaVerification" "UpdateGitOpsApp" "EcsServiceSetup" "EcsUpgradeContainer" "EcsBasicRollback" "ChaosInfrastructure" "Anchore" "Overrides" "AsgShiftTraffic" "AquaSecurity" "IDPStage" "ChaosHub" "CookieCutter" "CreateRepo" "DownloadAwsS3" "DirectPush" "RegisterCatalog" "K8sTrafficRouting" "DownloadHarnessStore" "CreateCatalog" "SlackNotify" "OsvScaner" "IACMOpenTofuPlugin" "AsgPhasedDeploy" "AsgSetup" "AsgRollback" "Test" "Wiz" "Certificates" "IACMCheckov" "IACMTFCompliance" "IACMTFLint" "IACMTFSec" "NotificationRule" "NotificationChannel"  
syncStatus
string
Sync Status of the Entity that may be QUEUED, SUCCESS or FAILED.


 Enum: "QUEUED" "SUCCESS" "FAILED" "OVERRIDDEN"  
Responses 
400
Bad Request


500
Internal Server Error


default
Returns the List of Files for Git Full sync.


post/ng/api/git-full-sync/files
Request samples 
{
  • "entityTypes": [
    ],
  • "syncStatus": "QUEUED"
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Trigger Full Sync
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Successfully Triggered Full Sync.


post/ng/api/git-full-sync
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Git Sync Settings