Git Sync Entities

This contains a list of APIs specific to Git Sync Entities

Lists Git Sync Entity filtered by their Type for the given scope

Request
Security:
ApiKey (readwrite)
path Parameters
entityType
required
string

Entity Type

Enum: "Projects" "Pipelines" "PipelineSteps" "Http" "JiraCreate" "ShellScript" "K8sCanaryDeploy" "Connectors" "Secrets" "Service" "Environment" "InputSets" "CvConfig" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "FeatureFlagStage" "Template" "Triggers" "MonitoredService" "GitRepositories" "FeatureFlags" "ServiceNowApproval"
query Parameters
projectIdentifier
string

Project Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

accountIdentifier
string

Account Identifier for the Entity

gitSyncConfigId
string

Git Sync Config Id

branch
string

Branch Name

page
integer <int32>
Default: 0

Indicates the number of pages. Results for these pages will be retrieved.

size
integer <int32>

The number of the elements to fetch

moduleType
string

Module Type

Responses
400

Bad Request

500

Internal Server Error

default

Paginated list of Git Sync Entities filtered by Entity Type

get/ng/api/git-sync-entities/{entityType}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/git-sync-entities/:entityType?projectIdentifier=string&orgIdentifier=string&accountIdentifier=string&gitSyncConfigId=string&branch=string&page=0&size=0&moduleType=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Git Sync Entity by product for the given list of Repos and Entity Types

Request
Security:
ApiKey (readwrite)
query Parameters
projectIdentifier
string

Project Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

accountIdentifier
string

Account Identifier for the Entity

size
integer <int32>

The number of the elements to fetch

Request Body schema:

Filter Git Sync Entity based on multiple parameters

moduleType
string

Module Type

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
gitSyncConfigIdentifiers
Array of strings

List of Git Sync Config Ids

entityTypes
Array of strings

List of Entity Types

Items Enum: "Projects" "Pipelines" "PipelineSteps" "Http" "JiraCreate" "ShellScript" "K8sCanaryDeploy" "Connectors" "Secrets" "Service" "Environment" "InputSets" "CvConfig" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "FeatureFlagStage" "Template" "Triggers" "MonitoredService" "GitRepositories" "FeatureFlags" "ServiceNowApproval"
searchTerm
string

Search Term

Responses
400

Bad Request

500

Internal Server Error

default

Paginated list of Git Sync Entities by product based on given list of Repos and Entity Types

post/ng/api/git-sync-entities/summary
Request samples
{
  • "moduleType": "CD",
  • "gitSyncConfigIdentifiers": [
    ],
  • "entityTypes": [
    ],
  • "searchTerm": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Git Sync Entity by product for the given Repo, Branch and list of Entity Types

Request
Security:
ApiKey (readwrite)
path Parameters
branch
required
string

Branch Name

query Parameters
projectIdentifier
string

Project Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

accountIdentifier
string

Account Identifier for the Entity

size
integer <int32>

The number of the elements to fetch

gitSyncConfigId
string

Git Sync Config Id

Request Body schema:

This filters the Git Sync Entity based on multiple parameters

moduleType
string

Module Type

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
entityTypes
Array of strings

List of Entity Types

Items Enum: "Projects" "Pipelines" "PipelineSteps" "Http" "JiraCreate" "ShellScript" "K8sCanaryDeploy" "Connectors" "Secrets" "Service" "Environment" "InputSets" "CvConfig" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "FeatureFlagStage" "Template" "Triggers" "MonitoredService" "GitRepositories" "FeatureFlags" "ServiceNowApproval"
searchTerm
string

Search Term

Responses
400

Bad Request

500

Internal Server Error

default

This contains a list of Product-wise Git Sync Entities specific to the given Repo, Branch, and Entity Types

post/ng/api/git-sync-entities/branch/{branch}
Request samples
{
  • "moduleType": "CD",
  • "entityTypes": [
    ],
  • "searchTerm": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}