Delegate Configuration Resource

Contains APIs related to Delegate Configuration management

Updates Scoping Rules for the Delegate Configuration specified by identifier

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

Delegate Configuration identifier

accountId
required
string

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

Request Body schema: */*

List of Delegate Scoping Rules to be updated

Array
description
string
environmentTypeId
string
environmentIds
Array of strings unique
Responses
400

Bad Request

500

Internal server error

default

Delegate Configuration which was updated.

put/ng/api/v2/accounts/{accountId}/delegate-configs/{delegateConfigIdentifier}/scoping-rules
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/:delegateConfigIdentifier/scoping-rules?orgId=string&projectId=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates Delegate selectors for Delegate Configuration specified by identifier

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

Delegate Configuration identifier

accountId
required
string

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

Request Body schema: */*

List of Delegate selectors to be updated

Array
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Configuration which was updated.

put/ng/api/v2/accounts/{accountId}/delegate-configs/{delegateConfigIdentifier}/selectors
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/:delegateConfigIdentifier/selectors?orgId=string&projectId=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d string
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Delegate Configuration for specified account, org and project and filter applied

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

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

filterIdentifier
string

Filter identifier

searchTerm
string

Search term

offset
string
Default: "0"
limit
string
fieldsIncluded
Array of strings
fieldsExcluded
Array of strings
Request Body schema: */*

Delegate Configuration filter properties: name, identifier, description, approvalRequired, list of selectors

name
string
identifier
string
description
string
approvalRequired
boolean
selectors
Array of strings
object
filterType
string
Enum: "CONNECTOR" "DELEGATEPROFILE" "DELEGATE" "PIPELINESETUP" "PIPELINEEXECUTION" "DEPLOYMENT" "AUDIT" "TEMPLATE"
Responses
400

Bad Request

500

Internal server error

default

A list of Delegate Configurations for the account, org and projec and filter appliedt

post/ng/api/v2/accounts/{accountId}/delegate-configs/listV2
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/listV2?orgId=string&projectId=string&filterIdentifier=string&searchTerm=string&offset=0&limit=string&fieldsIncluded=string&fieldsExcluded=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates Delegate Configuration specified by config details

Request
Security:
ApiKey (readwrite)
Request Body schema: */*

Delegate Configuration to be created. These include uuid, identifier, accountId, orgId, projId, name, startupScript, scopingRules, selectors...

uuid
string
accountId
string
name
string
description
string
primary
boolean
approvalRequired
boolean
startupScript
string
Array of objects (ScopingRuleDetailsNg)
selectors
Array of strings
object (EmbeddedUserDetails)
object (EmbeddedUserDetails)
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
identifier
string
numberOfDelegates
integer <int64>
orgIdentifier
string
projectIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Configuration which was created.

post/ng/api/v2/delegate-configs
Request samples
curl -i -X POST \
  https://app.harness.io/gateway/ng/api/v2/delegate-configs \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Delegate Configuration for specified account, org and project

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

Account id

query Parameters
offset
string
Default: "0"
limit
string
fieldsIncluded
Array of strings
fieldsExcluded
Array of strings
orgId
string

Organization Id

projectId
string

Project Id

Responses
400

Bad Request

500

Internal server error

default

A list of Delegate Configurations for the account, org and project

get/ng/api/v2/accounts/{accountId}/delegate-configs
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs?offset=0&limit=string&fieldsIncluded=string&fieldsExcluded=string&orgId=string&projectId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates Delegate Configuration specified by config details for specified account

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

Account id

Request Body schema: */*

Delegate Configuration to be created. These include uuid, identifier, accountId, orgId, projId, name, startupScript, scopingRules, selectors...

uuid
string
accountId
string
name
string
description
string
primary
boolean
approvalRequired
boolean
startupScript
string
Array of objects (ScopingRuleDetailsNg)
selectors
Array of strings
object (EmbeddedUserDetails)
object (EmbeddedUserDetails)
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
identifier
string
numberOfDelegates
integer <int64>
orgIdentifier
string
projectIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Configuration which was created.

post/ng/api/v2/accounts/{accountId}/delegate-configs
Request samples
curl -i -X POST \
  https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Retrieves Delegate Configuration details for given Delegate Configuration identifier.

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

Delegate Configuration identifier

accountId
required
string

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

Responses
400

Bad Request

500

Internal server error

default

A Delegate Configuration. It includes uuid, accountId, name, description, startupScript, scopingRules, selectors, numberOfDelegates and other info.

get/ng/api/v2/accounts/{accountId}/delegate-configs/{delegateConfigIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/:delegateConfigIdentifier?orgId=string&projectId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates Delegate Configuration specified by Identifier

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

Delegate Configuration identifier

accountId
required
string

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

Request Body schema: */*

Delegate configuration details to be updated. These include name, startupScript, scopingRules, selectors

uuid
string
accountId
string
name
string
description
string
primary
boolean
approvalRequired
boolean
startupScript
string
Array of objects (ScopingRuleDetailsNg)
selectors
Array of strings
object (EmbeddedUserDetails)
object (EmbeddedUserDetails)
createdAt
integer <int64>
lastUpdatedAt
integer <int64>
identifier
string
numberOfDelegates
integer <int64>
orgIdentifier
string
projectIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Configuration which was updated.

put/ng/api/v2/accounts/{accountId}/delegate-configs/{delegateConfigIdentifier}
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/:delegateConfigIdentifier?orgId=string&projectId=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Deletes Delegate Configuration specified by identifier

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

Delegate Configuration identifier

accountId
required
string

Account id

query Parameters
orgId
string

Organization Id

projectId
string

Project Id

Responses
400

Bad Request

500

Internal server error

default

Boolean value resulting true if deletion was successful.

delete/ng/api/v2/accounts/{accountId}/delegate-configs/{delegateConfigIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/v2/accounts/:accountId/delegate-configs/:delegateConfigIdentifier?orgId=string&projectId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}