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 Clusters API

This contains APIs related to Gitops Clusters

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

Tagged areas include Cluster. 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 17 operations across 12 paths, and defines 43 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}.

17 operations 12 paths 43 schemas 2 DELETE8 GET6 POST1 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 Clusters 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 17

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

Clusters 17

This contains APIs related to Gitops Clusters

GET
/ng/api/gitops/clusters/{identifier}
Get a Cluster linked to an environment by identifier
getCluster 7 params → 400500default
DELETE
/ng/api/gitops/clusters/{identifier}
Unlink a cluster by identifier
deleteCluster 7 params → 400500default
GET
/ng/api/gitops/clusters
Gets cluster list
getClusterList 10 params → 400500default
POST
/ng/api/gitops/clusters
Link a Cluster
linkCluster 1 param body → 400500default
POST
/ng/api/gitops/clusters/batch
Link Clusters
linkClusters 1 param body → 400500default
POST
/ng/api/gitops/clusters/batchunlink
Unlink Clusters
unlinkClustersInBatch 1 param body → 400500default
GET
/gitops/api/v1/agents/{agentIdentifier}/cluster_byname
Get a cluster managed by an agent by name
AgentClusterService_GetByName 6 params → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/cluster_byurl
Get a cluster managed by an agent by URL
AgentClusterService_GetByUrl 6 params → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/clusters
List returns list of clusters
AgentClusterService_List 10 params → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/clusters
Create creates a cluster
AgentClusterService_Create 5 params body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}
Get returns a cluster by identifier
AgentClusterService_Get 10 params → 200default
DELETE
/gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}
Delete deletes a cluster
AgentClusterService_Delete 11 params → 200default
PUT
/gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}
Update updates a cluster
AgentClusterService_Update 6 params body → 200default
GET
/gitops/api/v1/agents/{agentIdentifier}/gpgkeys
List all available repository certificates
AgentGPGKeyService_List 5 params → 200default
POST
/gitops/api/v1/agents/{agentIdentifier}/hosted/cluster
CreateHosted creates a harness hosted cluster
AgentClusterService_CreateHosted 1 param → 200default
POST
/gitops/api/v1/clusters
List clusters
ClusterService_ListClusters body → 200default
GET
/gitops/api/v1/clusters/exists
Check if a cluster exists
ClusterService_Exists 5 params → 200default

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are clustersCluster (16 properties), servicev1ClusterQuery (12 properties), servicev1Cluster (11 properties), clustersClusterConfig (11 properties). Each schema is shown below with its type and property counts.

ClusterRequest
object
This is the ClusterRequest entity defined in Harness
6 properties 1 required
v1Clusterlist
object
7 properties
clustersClusterType
string
ClusterBatchResponse
object
This is the Cluster Batch Response defined in Harness
4 properties
clustersClusterCreateRequest
object
4 properties
ClusterUnlinkRequest
object
Batch Request to unlink clusters to the environment in a batch
5 properties 1 required
servicev1Cluster
object
11 properties
commonsConnectionState
object
4 properties
servicev1ClusterQuery
object
12 properties
ValidationError
object
2 properties
gpgkeysGnuPGPublicKey
object
6 properties
ClusterBasicDTO
object
List of cluster identifiers and names
4 properties
clustersTLSClientConfig
object
5 properties
clustersClusterList
object
ClusterList is a collection of Clusters.
2 properties
Error1
object
This is Error entity as defined in Harness
7 properties
clustersClusterInfo
object
5 properties
ClusterLinkRequest
object
Batch Request to link clusters to the environment in a batch
7 properties 1 required
ResponseDTOClusterBatchResponse
object
4 properties
v1SortOrderOptions
string
gatewayruntimeError
object
4 properties
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
clustersAWSAuthConfig
object
2 properties
protobufFieldMask
object
paths: "f.a" paths: "f.b.d" Here f represents a field in some root message, a and b fields in the message found in f, and d a field found in the message in f.b…
1 property
clustersCluster
object
16 properties
v1ListMeta
object
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMe…
4 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
ResponseDTOBoolean
object
4 properties
ClusterResponse
object
This is the ClusterRequest entity defined in Harness
10 properties 1 required
ErrorMetadata2
object
This implements different error meta data objects
1 property
clustersClusterResponse
object
ClusterOperationResult
object
Result of a cluster link/unlink operation with success or failure details
5 properties
gpgkeysGnuPGPublicKeyList
object
2 properties
ClusterQueryClusterSortByOptions
string
ResponseMessage
object
7 properties
clustersClusterConfig
object
ClusterConfig is the configuration attributes. This structure is subset of the go-client rest.Config with annotations added for marshalling.
11 properties
clustersExecProviderConfig
object
5 properties
clustersClusterUpdateRequest
object
6 properties
clustersClusterID
object
2 properties
ResponseDTOClusterResponse
object
4 properties
PageResponseClusterResponse
object
8 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
ResponseDTOPageResponseClusterResponse
object
4 properties
clustersClusterCacheInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-clusters-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 Clusters 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.