Harness

Harness Agents API

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

GitHub OpenAPI

Operations 25

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /gitops/api/v1/agents List GitOps agents · Agent service for server list #
Ask an LLM
“Which GitOps agents are registered in my Harness project?”
“Can I list only the GitOps agents that are disconnected or unhealthy?”
Tell an agent
List the GitOps agents in project {project}.
Show GitOps agents whose health status is {health}.
POST /gitops/api/v1/agents Register a new GitOps agent · Agent service for server create #
Ask an LLM
“How do I register a new GitOps agent in Harness?”
“Can I create a GitOps agent scoped to a single project rather than the whole account?”
Tell an agent
Create a GitOps agent named {name} with identifier {identifier}.
Register a new GitOps agent {name} in project {project} of org {org}.
GET /gitops/api/v1/agents/ns List namespaces GitOps agents run in · Agent service for server list namespaces #
Ask an LLM
“Which Kubernetes namespaces are my GitOps agents installed in?”
“What namespaces are in use by agents in this project?”
Tell an agent
List the namespaces used by GitOps agents in project {project}.
Show every namespace my GitOps agents are deployed into.
GET /gitops/api/v1/agents/tags List tags used on GitOps agents · Agent service for server list tags #
Ask an LLM
“What tags have been applied to my GitOps agents?”
“Which agent tags exist in this org so I can filter by them?”
Tell an agent
List the tags on GitOps agents in org {org}.
Show all distinct GitOps agent tags.
GET /gitops/api/v1/agents/versions List versions of GitOps agents · Agent service for server list versions #
Ask an LLM
“Which versions are my GitOps agents running?”
“Are my agents on different versions across this project?”
Tell an agent
List the versions of GitOps agents in project {project}.
Show which GitOps agent versions are in use.
PUT /gitops/api/v1/agents/{agent.identifier} Update a GitOps agent's details · Update agents #
Ask an LLM
“Can I change the tags or metadata on an existing GitOps agent?”
“How do I rename or update the description of a GitOps agent?”
Tell an agent
Update GitOps agent {agent} to have the description {description}.
Change the tags on GitOps agent {agent} to {tags}.
GET /gitops/api/v1/agents/{agentIdentifier}/deploy.yaml Download an agent's install manifest YAML · Agent service for server get deploy yaml #
Ask an LLM
“Where do I get the Kubernetes YAML manifest to install a GitOps agent?”
“Can I fetch the agent install YAML for a specific namespace and skip the CRDs?”
Tell an agent
Get the deployment YAML for GitOps agent {agent} in namespace {namespace}.
Download the install manifest for agent {agent} without CRDs.
POST /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm Generate an agent Helm chart from settings · Agent service for server post deploy helm chart #
Ask an LLM
“Can I generate the GitOps agent Helm chart by posting proxy and Argo CD settings in the body?”
“What do I send to build a Helm chart for an agent with a custom CA and proxy?”
Tell an agent
Generate the Helm chart for agent {agent} using proxy settings {proxy}.
Build a Helm chart for GitOps agent {agent} targeting namespace {namespace} via a POST request.
POST /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/yaml Generate agent install YAML from posted settings · Agent service for server post deploy yaml #
Ask an LLM
“Can I post my proxy and private key settings to get a GitOps agent install YAML back?”
“Is there a POST version of the agent manifest generator that takes Argo CD settings?”
Tell an agent
Generate install YAML for agent {agent} with Argo CD settings {argocd} in the request body.
Post deployment settings for agent {agent} and return the plain YAML manifest for namespace {namespace}.
GET /gitops/api/v1/agents/{agentIdentifier}/helm-chart Download the Helm chart for an agent · Agent service for server get deploy helm chart #
Ask an LLM
“How do I download the Helm chart to install a GitOps agent?”
“Can I get the agent's Helm chart for a disaster recovery node?”
Tell an agent
Download the Helm chart for GitOps agent {agent}.
Get the Helm chart for agent {agent} for disaster recovery node {dr}.
GET /gitops/api/v1/agents/{agentIdentifier}/helm-overrides Get Helm values overrides for an agent · Agent service for server get deploy overrides #
Ask an LLM
“Where can I get the Helm values overrides file for my GitOps agent?”
“What overrides should I pass to helm install for this agent?”
Tell an agent
Get the Helm overrides for GitOps agent {agent}.
Fetch the values overrides for agent {agent} in namespace {namespace}.
POST /gitops/api/v1/agents/{agentIdentifier}/helm-overrides Generate Helm overrides from posted settings · Agent service for server post deploy overrides #
Ask an LLM
“Can I post proxy and CA settings to generate Helm overrides for an agent install?”
“Is there a way to build agent Helm values overrides from a request body?”
Tell an agent
Generate Helm overrides for agent {agent} posting the CA data {ca}.
Build the Helm values overrides for GitOps agent {agent} with a POST body.
GET /gitops/api/v1/agents/{agentIdentifier}/operator/yaml Get the operator YAML for an agent · Agent service for server get operator yaml #
Ask an LLM
“How do I get the operator YAML to deploy a GitOps agent with an operator?”
“Can I download the agent's operator manifest for a given namespace?”
Tell an agent
Get the operator YAML for GitOps agent {agent}.
Download the operator manifest for agent {agent} in namespace {namespace}.
POST /gitops/api/v1/agents/{agentIdentifier}/operator/yaml Generate operator YAML from posted settings · Agent service for server post operator yaml #
Ask an LLM
“Can I post my settings to generate an operator-based install YAML for an agent?”
“Is there a POST form of the operator manifest generator that accepts a private key?”
Tell an agent
Generate the operator YAML for agent {agent} by posting private key {key}.
Post operator settings for GitOps agent {agent} and return its operator manifest.
PATCH /gitops/api/v1/agents/{agentIdentifier}/primaryNode Set an agent's primary disaster recovery node · Agent service for server set primary node #
Ask an LLM
“How do I fail over a GitOps agent to its disaster recovery node?”
“Can I disable sync windows when switching the primary DR node?”
Tell an agent
Make disaster recovery node {dr} the primary node for agent {agent}.
Switch agent {agent} to its DR node and disable sync windows.
GET /gitops/api/v1/agents/{agentIdentifier}/sync-allowed Check whether an agent is allowed to sync · Agent service for server get sync allowed #
Ask an LLM
“Is syncing currently allowed for this GitOps agent?”
“Can I check if deny sync windows are blocking an agent?”
Tell an agent
Check whether GitOps agent {agent} is allowed to sync.
Show the sync-allowed status of agent {agent}.
PUT /gitops/api/v1/agents/{agentIdentifier}/sync-allowed Allow or block syncs for an agent · Agent service for server update sync allowed #
Ask an LLM
“How do I pause all syncs for a GitOps agent?”
“Can I block application syncs by adding deny sync windows to an agent's app projects?”
Tell an agent
Set sync allowed to {allowed} for GitOps agent {agent}.
Block syncs on agent {agent} by creating deny sync windows.
GET /gitops/api/v1/agents/{identifier} Get a GitOps agent's details · Agent service for server get #
Ask an LLM
“What are the details and health of a specific GitOps agent?”
“Can I look up one agent by its identifier and include its credentials?”
Tell an agent
Get GitOps agent {identifier}.
Show details for agent {identifier} in project {project}.
DELETE /gitops/api/v1/agents/{identifier} Delete a GitOps agent · Agent service for server delete #
Ask an LLM
“How do I remove a GitOps agent I no longer use?”
“Can I delete an agent that belongs to a specific project?”
Tell an agent destructive · confirm first
Delete GitOps agent {identifier}.
Remove agent {identifier} from project {project}.
POST /gitops/api/v1/agents/{identifier}/credentials Regenerate a GitOps agent's credentials · Agent service for server regenerate credentials #
Ask an LLM
“How do I rotate the credentials a GitOps agent uses to connect?”
“Can I issue fresh credentials for an agent whose secret leaked?”
Tell an agent
Regenerate credentials for GitOps agent {identifier}.
Issue new connection credentials for agent {identifier}.
POST /gitops/api/v1/agents/{identifier}/scale Scale a hosted GitOps agent · Agent service for server scale #
Ask an LLM
“How do I change the number of replicas for a Harness-hosted GitOps agent?”
“Can I scale up a hosted agent to handle more applications?”
Tell an agent
Scale hosted agent {identifier} to {replicas} replicas.
Scale up hosted GitOps agent {identifier}.
GET /gitops/api/v1/agents/{identifier}/secret-resolution/enabled Check if secret resolution is enabled for an agent · GetSecretResolutionEnabled reports whether Harness secret resolution is enabled… #
Ask an LLM
“Is Harness secret resolution turned on for this GitOps agent?”
“Can an agent resolve Harness secrets in its manifests?”
Tell an agent
Check whether secret resolution is enabled on agent {identifier}.
Tell me if GitOps agent {identifier} can resolve Harness secrets.
GET /gitops/api/v1/agents/{identifier}/unique Check an agent identifier for uniqueness · Agent service for server unique #
Ask an LLM
“Is this GitOps agent identifier already taken?”
“Can I verify an agent identifier is unique before creating it?”
Tell an agent
Check if agent identifier {identifier} is unique.
Verify no other GitOps agent already uses {identifier}.
GET /gitops/api/v2/versions/agents/upgrade-available Check for a newer GitOps agent version · Version upgrade service upgrade available V2 #
Ask an LLM
“Is there a newer GitOps agent version I should upgrade to?”
“What agent upgrade is available for the version I'm running?”
Tell an agent
Check whether an upgrade is available for agent version {version}.
See if a new GitOps agent release is out.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-agents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v1-agent-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v1-agent-query-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v1-agent-set-primary-node-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v1-version-upgrade-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v1-agent-sync-allowed-update-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-gitopsservicev1-namespace-list-schema.json

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Agents API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-agents-api-openapi.yml