Agents

AgentServiceForServer_Create

Create agent.

SecurityApiKey
Request
Request Body schema: application/json
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"
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"
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"
}
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"
}

AgentServiceForServer_Delete

Delete agents.

SecurityApiKey
Request
path Parameters
identifier
required
string
query Parameters
accountIdentifier
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"
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"
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"
}

AgentServiceForServer_Get

Get agents.

SecurityApiKey
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"
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"
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"
}

AgentServiceForServer_GetDeployYaml

GetDeployYaml returns depoyment yamls for agents.

SecurityApiKey
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
Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
Request samples

AgentServiceForServer_List

List agents.

SecurityApiKey
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"

MANAGED_ARGO_PROVIDER

Enum: "AGENT_TYPE_UNSET" "CONNECTED_ARGO_PROVIDER" "MANAGED_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"
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_RegenerateCredentials

Regenerate credentials for agents.

SecurityApiKey
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"
}

AgentServiceForServer_Unique

Unique returns unique agents.

SecurityApiKey
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"
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"
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
}

AgentServiceForServer_Update

Update agents.

SecurityApiKey
Request
path Parameters
agent.identifier
required
string

The gitops-server generated ID for this gitops-agent

Request Body schema: application/json
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"
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"
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"
}
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"
}