How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Agents API

The Agents API from Harness — 20 operation(s) for agents.

Harness Agents API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 25 operations across 20 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

25 operations 20 paths 39 schemas 1 DELETE13 GET1 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Agents API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 25

Across 20 paths, the API surfaces 25 operations — 1 DELETE, 13 GET, 1 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Agents 25
GET
/gitops/api/v1/agents
Agent service for server list
AgentServiceForServer_List 20 params → 200default
POST
/gitops/api/v1/agents
Agent service for server create
AgentServiceForServer_Create body → 200default
GET
/gitops/api/v1/agents/ns
Agent service for server list namespaces
AgentServiceForServer_ListNamespaces 20 params → 200default
POST
/gitops/api/v1/agents/search
Agent service for server search
AgentServiceForServer_Search body → 200default
GET
/gitops/api/v1/agents/tags
Agent service for server list tags
AgentServiceForServer_ListTags 20 params → 200default
GET
/gitops/api/v1/agents/versions
Agent service for server list versions
AgentServiceForServer_ListVersions 20 params → 200default
PUT
/gitops/api/v1/agents/{agent.identifier}
Update agents
AgentServiceForServer_Update 1 param body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
Agent service for server get deploy yaml
AgentServiceForServer_GetDeployYaml 18 params → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm
Agent service for server post deploy helm chart
AgentServiceForServer_PostDeployHelmChart 1 param body → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/yaml
Agent service for server post deploy yaml
AgentServiceForServer_PostDeployYaml 1 param body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/helm-chart
Agent service for server get deploy helm chart
AgentServiceForServer_GetDeployHelmChart 18 params → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/helm-overrides
Agent service for server get deploy overrides
AgentServiceForServer_GetDeployOverrides 18 params → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/helm-overrides
Agent service for server post deploy overrides
AgentServiceForServer_PostDeployOverrides 1 param body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/operator/yaml
Agent service for server get operator yaml
AgentServiceForServer_GetOperatorYaml 18 params → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/operator/yaml
Agent service for server post operator yaml
AgentServiceForServer_PostOperatorYaml 1 param body → 200default
PATCH
/gitops/api/v1/agents/{agentIdentifier}/primaryNode
Agent service for server set primary node
AgentServiceForServer_SetPrimaryNode 1 param body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/sync-allowed
Agent service for server get sync allowed
AgentServiceForServer_GetSyncAllowed 5 params → 200default
PUT
/gitops/api/v1/agents/{agentIdentifier}/sync-allowed
Agent service for server update sync allowed
AgentServiceForServer_UpdateSyncAllowed 1 param body → 200default
GET
/gitops/api/v1/agents/{identifier}
Agent service for server get
AgentServiceForServer_Get 20 params → 200default
DELETE
/gitops/api/v1/agents/{identifier}
Agent service for server delete
AgentServiceForServer_Delete 20 params → 200default
POST
/gitops/api/v1/agents/{identifier}/credentials
Agent service for server regenerate credentials
AgentServiceForServer_RegenerateCredentials 1 param → 200default
POST
/gitops/api/v1/agents/{identifier}/scale
Agent service for server scale
AgentServiceForServer_Scale 1 param body → 200default
GET
/gitops/api/v1/agents/{identifier}/secret-resolution/enabled
GetSecretResolutionEnabled reports whether Harness secret resolution is enabled…
AgentServiceForServer_GetSecretResolutionEnabled 20 params → 200default
GET
/gitops/api/v1/agents/{identifier}/unique
Agent service for server unique
AgentServiceForServer_Unique 20 params → 200default
GET
/gitops/api/v2/versions/agents/upgrade-available
Version upgrade service upgrade available V2
VersionUpgradeService_UpgradeAvailableV2 1 param → 200default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are v1AgentQuery (22 properties), v1Agent (21 properties), v1AgentYamlQuery (11 properties), v1AgentHealth (8 properties). Each schema is shown below with its type and property counts.

v1ClusterInfraType
string
runtimeStreamError
object
5 properties
v1DisasterRecoveryType
string
v1Agent
object
21 properties
v1SecretResolutionEnabledResponse
object
1 property
v1AgentYamlQuery
object
11 properties
v1ConnectedStatus
string
AgentQueryAgentSortByOptions
string
v1AgentSetPrimaryNodeRequest
object
6 properties
servicev1AppProjectMapping
object
1 property
v1AgentQuery
object
22 properties
v1AgentCredentials
object
2 properties
v1AgentSyncAllowedUpdateRequest
object
6 properties
v1AgentMetadata
object
7 properties
v1AgentComponentHealth
object
4 properties
v1SortOrderOptions
string
v1Proxy
object
5 properties
gatewayruntimeError
object
4 properties
v1AgentScope
string
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
v1DownloadResponse
object
1 property
v1AgentOperator
string
servicev1Project
object
3 properties
v1SyncAllowedResponse
object
1 property
v1AgentHealth
object
8 properties
v1TagMap
object
7 properties
v1VersionList
object
7 properties
v1AgentScaleRequest
object
6 properties
v1AgentList
object
7 properties
v1UniqueMessage
object
1 property
gitopsservicev1NamespaceList
object
7 properties
gitopsservicev1Namespace
object
1 property
v1DisasterRecoveryNode
object
3 properties
v1ArgoCDSettings
object
4 properties
v1VersionUpgradeResponse
object
7 properties
v1SemanticVersion
object
3 properties
v1Time
object
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 pack…
2 properties
servicev1HealthStatus
string
v1AgentType
string
AgentType is the type of agent. CONNECTEDARGOPROVIDER is deprecated and will be removed in a future release. Please use type "MANAGEDARGOPROVIDER" to create yo…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-agents-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.