Git Sync Settings

Contains APIs related to Git Sync Settings

Get Git Sync Setting for the given scope

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

Responses
400

Bad Request

500

Internal Server Error

default

Git Sync Setting of the given scope

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

This updates the existing Git Sync settings within the scope. Only changing Connectivity Mode is allowed

Request
Security:
ApiKey (readwrite)
Request Body schema:

This contains details of Git Sync Settings

accountIdentifier
required
string

Account Identifier for the Entity

projectIdentifier
required
string

Project Identifier for the Entity

organizationIdentifier
required
string

Organization Identifier for the Entity

executeOnDelegate
required
boolean

Specifies Connectivity Mode for Git Sync. If True, executes through Delegate, else executes through Platform. The default value is True

Responses
400

Bad Request

500

Internal Server Error

default

Updated Git Sync Setting

put/ng/api/git-sync-settings
Request samples
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "organizationIdentifier": "string",
  • "executeOnDelegate": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates Git Sync Setting in a scope

Request
Security:
ApiKey (readwrite)
Request Body schema:

This contains details of Git Sync settings like - (scope, executionOnDelegate)

accountIdentifier
required
string

Account Identifier for the Entity

projectIdentifier
required
string

Project Identifier for the Entity

organizationIdentifier
required
string

Organization Identifier for the Entity

executeOnDelegate
required
boolean

Specifies Connectivity Mode for Git Sync. If True, executes through Delegate, else executes through Platform. The default value is True

Responses
400

Bad Request

500

Internal Server Error

default

Successfully created Git Sync Setting

post/ng/api/git-sync-settings
Request samples
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "organizationIdentifier": "string",
  • "executeOnDelegate": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}