Harness

Delegate Setup Resource

Contains Delegate Setup APIs

Deletes a Delegate by its identifier.

Securityx-api-key
Request
path Parameters
delegateIdentifier
required
string

Identifier for the Entity.

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

200 Ok response if everything successfully deleted delegate

delete/ng/api/delegate-setup/delegate/{delegateIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Generates delegate terraform example module file from the account
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
Generated terraform module file.


get/ng/api/delegate-setup/delegate-terraform-module-file
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Generates helm values yaml file from the data specified in request body (Delegate setup details).
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: application/json
required
Delegate setup details, containing data to populate yaml file values.


orgIdentifier
string
 
projectIdentifier
string
 
name
required
string
 
description
string
 
size
string
 Enum: "LAPTOP" "SMALL" "MEDIUM" "LARGE"  
hostName
string
 
delegateConfigurationId
string
 
identifier
string
 
object (K8sConfigDetails) 
 
tags
Array of strings  unique 
 
delegateType
required
string
Currently KUBERNETES and HELM_DELEGATE are supported.


 
tokenName
string
 
runAsRoot
boolean
 
version
string
 
Responses 
400
Bad Request


500
Internal server error


default
Generated yaml file.


post/ng/api/delegate-setup/generate-helm-values
Request samples 
application/json
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "size": "LAPTOP",
  • "hostName": "string",
  • "delegateConfigurationId": "string",
  • "identifier": "string",
  • "k8sConfigDetails": {
    },
  • "tags": [
    ],
  • "delegateType": "string",
  • "tokenName": "string",
  • "runAsRoot": true,
  • "version": "string"
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Lists all delegates in NG filtered by provided conditions
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: application/json
Details of the Delegate filter properties to be applied


status
string
Filter on delegate connectivity


 Enum: "CONNECTED" "DISCONNECTED" "ENABLED" "WAITING_FOR_APPROVAL" "DISABLED" "DELETED"  
description
string
Filter on delegate description


 
hostName
string
Filter on delegate hostName


 
delegateName
string
Filter on delegate name


 
delegateType
string
Filter on delegate type


 
delegateGroupIdentifier
string
Filter on delegate group id


 
delegateTags
Array of strings  unique 
Filter on delegate tags


 
delegateInstanceFilter
string
Filter on delegate instance status


 Enum: "EXPIRED" "AVAILABLE"  
object
Filter tags as a key-value pair.


 
filterType
required
string
This specifies the corresponding Entity of the filter.


 Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "Trigger" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment" "RuleExecution" "Override" "InputSet"  
Responses 
400
Bad Request


500
Internal server error


default
Lists all delegates in NG


post/ng/api/delegate-setup/listDelegates
Request samples 
application/json
{
  • "status": "CONNECTED",
  • "description": "string",
  • "hostName": "string",
  • "delegateName": "string",
  • "delegateType": "string",
  • "delegateGroupIdentifier": "string",
  • "delegateTags": [
    ],
  • "delegateInstanceFilter": "EXPIRED",
  • "tags": {
    },
  • "filterType": "Connector"
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets the latest supported delegate version. The version has YY.MM.XXXXX format. You can use any version lower than the returned results(upto 3 months old)
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
Gets the latest supported delegate version


get/ng/api/delegate-setup/latest-supported-version
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Overrides delegate image tag for account
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
 
delegateTag
required
string
 
validTillNextRelease
boolean
 Default:  false
 if set to true, harness will override your custom tag when new delegate is released


 
validForDays
integer <int32> 
 Default:  180
days after which harness will override your custom tag


 
Responses 
400
Bad Request


500
Internal server error


default
Delegate Image Tag


put/ng/api/delegate-setup/override-delegate-tag
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Delegate Token Resource