Harness

Agents

AgentServiceForServer_List

List agents.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

identifier
string
name
string
type
required
string
Default: "AGENT_TYPE_UNSET"
Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"
tags
Array of strings
searchTerm
string
pageSize
integer <int32>
pageIndex
integer <int32>
scope
string
Default: "AGENT_SCOPE_UNSET"
Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"
drIdentifier
string
sortBy
string
Default: "SORT_BY_NOT_SET"
Enum: "SORT_BY_NOT_SET" "NAME" "HEALTH_STATUS" "CONNECTIVITY_STATUS"
sortOrder
string
Default: "SORT_ORDER_NOT_SET"
Enum: "SORT_ORDER_NOT_SET" "ASC" "DESC"
metadataOnly
boolean
ignoreScope
boolean
connectedStatus
string
Default: "CONNECTED_STATUS_UNSET"
Enum: "CONNECTED_STATUS_UNSET" "CONNECTED" "DISCONNECTED"
healthStatus
string
Default: "HEALTH_STATUS_UNSET"
Enum: "HEALTH_STATUS_UNSET" "HEALTHY" "UNHEALTHY"
Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}
AgentServiceForServer_Create
Create agent.


Securityx-api-key 
Request 
Request Body schema: application/json
required
accountIdentifier
string (The ID of the Harness Account that this gitops-agent belongs to) 
Account Identifier for the Entity.


 
projectIdentifier
string (The ID of the Harness Project that this gitops-agent belongs to) 
Project Identifier for the Entity.


 
orgIdentifier
string (The ID of the Harness Organization that this gitops-agent belongs to) 
Organization Identifier for the Entity.


 
identifier
string (The gitops-server generated ID for this gitops-agent) 
 
name
string (A human readable name for the gitops-agent) 
 
object (v1AgentMetadata) 
 
description
string (A human readable description for the gitops-agent) 
 
type
string (v1AgentType) 
 Default:  "AGENT_TYPE_UNSET"
 Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"  
object (v1Time) 
Time is a wrapper around time.Time which supports correct
marshaling to YAML and JSON.  Wrappers are provided for many
of the factory methods that the time package offers.


+protobuf.options.marshal=false
+protobuf.as=Timestamp
+protobuf.options.(gogoproto.goproto_stringer)=false


 
object (v1Time) 
Time is a wrapper around time.Time which supports correct
marshaling to YAML and JSON.  Wrappers are provided for many
of the factory methods that the time package offers.


+protobuf.options.marshal=false
+protobuf.as=Timestamp
+protobuf.options.(gogoproto.goproto_stringer)=false


 
object (Tags that help organize gitops-agents) 
 
object (v1AgentHealth) 
 
object (v1AgentCredentials) 
 
object (v1SemanticVersion) 
 
upgradeAvailable
boolean (Indicates whether this agent has an upgrade available (i.e. the version of this gitops-agent is not the latest released)) 
 
scope
string (v1AgentScope) 
 Default:  "AGENT_SCOPE_UNSET"
 Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"  
object (v1DisasterRecoveryNode) 
 
isPLG
boolean
Indicates if the agent is for PLG.


 
operator
string (v1AgentOperator) 
 Default:  "UNKNOWN"
 Enum: "UNKNOWN" "ARGO" "FLAMINGO"  
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_Update
Update agents.


Securityx-api-key 
Request 
path Parameters
agent.identifier
required
string
The gitops-server generated ID for this gitops-agent


 
Request Body schema: application/json
required
accountIdentifier
string (The ID of the Harness Account that this gitops-agent belongs to) 
Account Identifier for the Entity.


 
projectIdentifier
string (The ID of the Harness Project that this gitops-agent belongs to) 
Project Identifier for the Entity.


 
orgIdentifier
string (The ID of the Harness Organization that this gitops-agent belongs to) 
Organization Identifier for the Entity.


 
identifier
string (The gitops-server generated ID for this gitops-agent) 
 
name
string (A human readable name for the gitops-agent) 
 
object (v1AgentMetadata) 
 
description
string (A human readable description for the gitops-agent) 
 
type
string (v1AgentType) 
 Default:  "AGENT_TYPE_UNSET"
 Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"  
object (v1Time) 
Time is a wrapper around time.Time which supports correct
marshaling to YAML and JSON.  Wrappers are provided for many
of the factory methods that the time package offers.


+protobuf.options.marshal=false
+protobuf.as=Timestamp
+protobuf.options.(gogoproto.goproto_stringer)=false


 
object (v1Time) 
Time is a wrapper around time.Time which supports correct
marshaling to YAML and JSON.  Wrappers are provided for many
of the factory methods that the time package offers.


+protobuf.options.marshal=false
+protobuf.as=Timestamp
+protobuf.options.(gogoproto.goproto_stringer)=false


 
object (Tags that help organize gitops-agents) 
 
object (v1AgentHealth) 
 
object (v1AgentCredentials) 
 
object (v1SemanticVersion) 
 
upgradeAvailable
boolean (Indicates whether this agent has an upgrade available (i.e. the version of this gitops-agent is not the latest released)) 
 
scope
string (v1AgentScope) 
 Default:  "AGENT_SCOPE_UNSET"
 Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"  
object (v1DisasterRecoveryNode) 
 
isPLG
boolean
Indicates if the agent is for PLG.


 
operator
string (v1AgentOperator) 
 Default:  "UNKNOWN"
 Enum: "UNKNOWN" "ARGO" "FLAMINGO"  
Responses 
200
A successful response.


default
An unexpected error response.


put/gitops/api/v1/agents/{agent.identifier}
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_GetDeployYaml
GetDeployYaml returns deployment yamls for agents.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for 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.


 
namespace
string
 
disasterRecoveryIdentifier
string
Disaster Recovery Identifier for entity.


 
skipCrds
boolean
 
caData
string
Certificate chain for the agent, must be base64 encoded.


 
proxy.http
string
 
proxy.https
string
 
proxy.username
string
 
proxy.password
string
 
proxy.skipSSLVerify
boolean
 
header Parameters
Accept
required
string
 Enum: "application/yaml" "application/json"  
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
Request samples 
AgentServiceForServer_PostDeployHelmChart
PostDeployHelmChart returns the Helm Chart for deploying the agents.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
Request Body schema: application/json
required
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
agentIdentifier
string
Agent identifier for entity.


 
namespace
string
 
disasterRecoveryIdentifier
string
Disaster Recovery Identifier for entity.


 
skipCrds
boolean
 
caData
string
Certificate chain for the agent, must be base64 encoded.


 
object (v1Proxy) 
 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "namespace": "string",
  • "disasterRecoveryIdentifier": "string",
  • "skipCrds": true,
  • "caData": "string",
  • "proxy": {
    }
}
AgentServiceForServer_PostDeployYaml
PostDeployYaml returns deployment yamls for agents.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
header Parameters
Accept
required
string
 Enum: "application/yaml" "application/json"  
Request Body schema: application/json
required
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
agentIdentifier
string
Agent identifier for entity.


 
namespace
string
 
disasterRecoveryIdentifier
string
Disaster Recovery Identifier for entity.


 
skipCrds
boolean
 
caData
string
Certificate chain for the agent, must be base64 encoded.


 
object (v1Proxy) 
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/yaml
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "namespace": "string",
  • "disasterRecoveryIdentifier": "string",
  • "skipCrds": true,
  • "caData": "string",
  • "proxy": {
    }
}
AgentServiceForServer_GetDeployHelmChart
GetDeployHelmChart returns the Helm Chart for deploying the agents.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for 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.


 
namespace
string
 
disasterRecoveryIdentifier
string
Disaster Recovery Identifier for entity.


 
skipCrds
boolean
 
caData
string
Certificate chain for the agent, must be base64 encoded.


 
proxy.http
string
 
proxy.https
string
 
proxy.username
string
 
proxy.password
string
 
proxy.skipSSLVerify
boolean
 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/helm-chart
Request samples 
AgentServiceForServer_SetPrimaryNode
Set primary disaster recovery node.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
Request Body schema: application/json
required
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
agentIdentifier
string
Agent identifier for entity.


 
disasterRecoveryIdentifier
string
Disaster Recovery Identifier for entity.


 
disableSyncWindows
boolean
Disable sync windows for the new primary agent.


 
Responses 
200
A successful response.


default
An unexpected error response.


patch/gitops/api/v1/agents/{agentIdentifier}/primaryNode
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "disasterRecoveryIdentifier": "string",
  • "disableSyncWindows": true
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_Get
Get agents.


Securityx-api-key 
Request 
path Parameters
identifier
required
string
 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
name
string
 
type
string
 Default:  "AGENT_TYPE_UNSET"
 Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"  
tags
Array of strings
 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
scope
string
 Default:  "AGENT_SCOPE_UNSET"
 Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"  
drIdentifier
string
 
sortBy
string
 Default:  "SORT_BY_NOT_SET"
 Enum: "SORT_BY_NOT_SET" "NAME" "HEALTH_STATUS" "CONNECTIVITY_STATUS"  
sortOrder
string
 Default:  "SORT_ORDER_NOT_SET"
 Enum: "SORT_ORDER_NOT_SET" "ASC" "DESC"  
metadataOnly
boolean
 
ignoreScope
boolean
 
connectedStatus
string
 Default:  "CONNECTED_STATUS_UNSET"
 Enum: "CONNECTED_STATUS_UNSET" "CONNECTED" "DISCONNECTED"  
healthStatus
string
 Default:  "HEALTH_STATUS_UNSET"
 Enum: "HEALTH_STATUS_UNSET" "HEALTHY" "UNHEALTHY"  
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{identifier}
Request samples 
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_Delete
Delete agents.


Securityx-api-key 
Request 
path Parameters
identifier
required
string
 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
name
string
 
type
string
 Default:  "AGENT_TYPE_UNSET"
 Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"  
tags
Array of strings
 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
scope
string
 Default:  "AGENT_SCOPE_UNSET"
 Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"  
drIdentifier
string
 
sortBy
string
 Default:  "SORT_BY_NOT_SET"
 Enum: "SORT_BY_NOT_SET" "NAME" "HEALTH_STATUS" "CONNECTIVITY_STATUS"  
sortOrder
string
 Default:  "SORT_ORDER_NOT_SET"
 Enum: "SORT_ORDER_NOT_SET" "ASC" "DESC"  
metadataOnly
boolean
 
ignoreScope
boolean
 
connectedStatus
string
 Default:  "CONNECTED_STATUS_UNSET"
 Enum: "CONNECTED_STATUS_UNSET" "CONNECTED" "DISCONNECTED"  
healthStatus
string
 Default:  "HEALTH_STATUS_UNSET"
 Enum: "HEALTH_STATUS_UNSET" "HEALTHY" "UNHEALTHY"  
Responses 
200
A successful response.


default
An unexpected error response.


delete/gitops/api/v1/agents/{identifier}
Request samples 
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_RegenerateCredentials
Regenerate credentials for agents.


Securityx-api-key 
Request 
path Parameters
identifier
required
string
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{identifier}/credentials
Request samples 
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "metadata": {
    },
  • "description": "string",
  • "type": "AGENT_TYPE_UNSET",
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "tags": {
    },
  • "health": {
    },
  • "credentials": {
    },
  • "version": {
    },
  • "upgradeAvailable": true,
  • "scope": "AGENT_SCOPE_UNSET",
  • "disasterRecoveryNode": {
    },
  • "isPLG": true,
  • "operator": "UNKNOWN"
}
AgentServiceForServer_Unique
Unique returns unique agents.


Securityx-api-key 
Request 
path Parameters
identifier
required
string
 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
name
string
 
type
string
 Default:  "AGENT_TYPE_UNSET"
 Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_ARGO_PROVIDER" "HOSTED_ARGO_PROVIDER"  
tags
Array of strings
 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
scope
string
 Default:  "AGENT_SCOPE_UNSET"
 Enum: "AGENT_SCOPE_UNSET" "ACCOUNT" "ORG" "PROJECT"  
drIdentifier
string
 
sortBy
string
 Default:  "SORT_BY_NOT_SET"
 Enum: "SORT_BY_NOT_SET" "NAME" "HEALTH_STATUS" "CONNECTIVITY_STATUS"  
sortOrder
string
 Default:  "SORT_ORDER_NOT_SET"
 Enum: "SORT_ORDER_NOT_SET" "ASC" "DESC"  
metadataOnly
boolean
 
ignoreScope
boolean
 
connectedStatus
string
 Default:  "CONNECTED_STATUS_UNSET"
 Enum: "CONNECTED_STATUS_UNSET" "CONNECTED" "DISCONNECTED"  
healthStatus
string
 Default:  "HEALTH_STATUS_UNSET"
 Enum: "HEALTH_STATUS_UNSET" "HEALTHY" "UNHEALTHY"  
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{identifier}/unique
Request samples 
Response samples 
application/json
{
  • "unique": true
}
➔ Next to Application