v2

Lists the delegate configs with filter

Request
Security:
ApiKey (readwrite)
path Parameters
accountId
required
string
query Parameters
orgId
string
projectId
string
filterIdentifier
string
searchTerm
string
offset
string
Default: "0"
limit
string
fieldsIncluded
Array of strings
fieldsExcluded
Array of strings
Request Body schema: */*
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
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": [
    ],
  • "responseMessages": [
    ]
}

Updates the scoping rules inside the delegate config

Request
Security:
ApiKey (readwrite)
path Parameters
delegateConfigIdentifier
required
string
accountId
required
string
query Parameters
orgId
string
projectId
string
Request Body schema: */*
Array
description
string
environmentTypeId
string
environmentIds
Array of strings unique
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Updates the selectors inside the delegate config

Request
Security:
ApiKey (readwrite)
path Parameters
delegateConfigIdentifier
required
string
accountId
required
string
query Parameters
orgId
string
projectId
string
Request Body schema: */*
Array
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Adds a delegate profile

Request
Security:
ApiKey (readwrite)
Request Body schema: */*
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
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Lists the delegate configs

Request
Security:
ApiKey (readwrite)
path Parameters
accountId
required
string
query Parameters
offset
string
Default: "0"
limit
string
fieldsIncluded
Array of strings
fieldsExcluded
Array of strings
orgId
string
projectId
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": [
    ],
  • "responseMessages": [
    ]
}

Adds a delegate profile

Request
Security:
ApiKey (readwrite)
path Parameters
accountId
required
string
Request Body schema: */*
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
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Gets delegate config by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
delegateConfigIdentifier
required
string
accountId
required
string
query Parameters
orgId
string
projectId
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Updates a delegate config

Request
Security:
ApiKey (readwrite)
path Parameters
delegateConfigIdentifier
required
string
accountId
required
string
query Parameters
orgId
string
projectId
string
Request Body schema: */*
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
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Deletes a delegate config by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
delegateConfigIdentifier
required
string
accountId
required
string
query Parameters
orgId
string
projectId
string
Responses
200

successful operation

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
application/json
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}