Create and manage organizations in your account. You use organizations to group together related projects. For example, you can use an organization to group together projects within a business unit or division.
Harness APIs (1.0)
The Harness Software Delivery Platform uses OpenAPI Specification v3.0. Harness constantly improves these APIs. Please be aware that some improvements could cause breaking changes.
The Harness API allows you to integrate and use all the services and modules we provide on the Harness Platform. If you use client-side SDKs, Harness functionality can be integrated with your client-side automation, helping you reduce manual efforts and deploy code faster.
For more information about how Harness works, visit the Harness Developer Hub.
The Harness API is a RESTful API that uses standard HTTP verbs. You can send requests in JSON, YAML, or form-data format. The format of the response matches the format of your request. You must send a single request at a time and ensure that you include your authentication key. For more information about this, go to Authentication.
Before you start integrating, get to know our API better by reading the following topics:
The methods you need to integrate with depend on the functionality you want to use. Work with your Harness Solutions Engineer to determine which methods you need.
To authenticate with the Harness API, you need to:
- Generate an API token on the Harness Platform.
- Send the API token you generate in the
x-api-keyheader in each request.
To generate an API token, complete the following steps:
- Go to the Harness Platform.
- On the left-hand navigation, click My Profile.
- Click +API Key, enter a name for your key and then click Save.
- Within the API Key tile, click +Token.
- Enter a name for your token and click Generate Token. Important: Make sure to save your token securely. Harness does not store the API token for future reference, so make sure to save your token securely before you leave the page.
Send the token you created in the Harness Platform in the x-api-key header. For example: x-api-key: YOUR_API_KEY_HERE
The structure for each request and response is outlined in the API documentation. We have examples in JSON and YAML for every request and response. You can use our online editor to test the examples.
| Field Name | Type | Default | Description |
|---|---|---|---|
| identifier | string | none | URL-friendly version of the name, used to identify a resource within it's scope and so needs to be unique within the scope. |
| name | string | none | Human-friendly name for the resource. |
| org | string | none | Limit to provided org identifiers. |
| project | string | none | Limit to provided project identifiers. |
| description | string | none | More information about the specific resource. |
| tags | map[string]string | none | List of labels applied to the resource. |
| order | string | desc | Order to use when sorting the specified fields. Type: enum(asc,desc). |
| sort | string | none | Fields on which to sort. Note: Specify the fields that you want to use for sorting. When doing so, consider the operational overhead of sorting fields. |
| limit | int | 30 | Pagination: Number of items to return. |
| page | int | 1 | Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page. |
| created | int64 | none | Unix timestamp that shows when the resource was created (in milliseconds). |
| updated | int64 | none | Unix timestamp that shows when the resource was last edited (in milliseconds). |
Harness uses conventional HTTP status codes to indicate the status of an API request. Generally, 2xx responses are reserved for success and 4xx status codes are reserved for failures. A 5xx response code indicates an error on the Harness server.
| Error Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 202 | Accepted |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 412 | Precondition Failed |
| 415 | Unsupported Media Type |
| 500 | Server Error |
To view our error response structures, go here.
The current version of our Beta APIs is yet to be announced. The version number will use the date-header format and will be valid only for our Beta APIs.
All our beta APIs are versioned as a Generation, and this version is included in the path to every API resource. For example, v1 beta APIs begin with app.harness.io/v1/, where v1 is the API Generation.
The version number represents the core API and does not change frequently. The version number changes only if there is a significant departure from the basic underpinnings of the existing API. For example, when Harness performs a system-wide refactoring of core concepts or resources.
We use pagination to place limits on the number of responses associated with list endpoints. Pagination is achieved by the use of limit query parameters. The limit defaults to 30. Its maximum value is 100.
Following are the pagination headers supported in the response bodies of paginated APIs:
- X-Total-Elements : Indicates the total number of entries in a paginated response.
- X-Page-Number : Indicates the page number currently returned for a paginated response.
- X-Page-Size : Indicates the number of entries per page for a paginated response.
For example:
X-Total-Elements : 30
X-Page-Number : 0
X-Page-Size : 10Download OpenAPI description
Overview
Languages
Servers
Mock server
https://apidocs.harness.io/_mock/openapi-merged/
Harness host URL
https://app.harness.io/
Vanity URL
https://{vanity}/
Request
This API can be used to update an agent's details in Harness. The following fields will be updated to the new values in the body - "tags", "metadata"(all nested fields in metadata will be replaced with new provided values including empty/nil values if they're sent), "description", "type".
Security
x-api-key
Account Identifier for the Entity.
Project Identifier for the Entity.
Organization Identifier for the Entity.
AgentType is the type of agent. CONNECTED_ARGO_PROVIDER is deprecated and will be removed in a future release.
Please use type "MANAGED_ARGO_PROVIDER" to create your agents.
"MANAGED_ARGO_PROVIDER" agents are user managed agents and "HOSTED_ARGO_PROVIDER" agents are Harness managed agents(these cannot be created by users directly).
Default "AGENT_TYPE_UNSET"
Enum"AGENT_TYPE_UNSET""CONNECTED_ARGO_PROVIDER""MANAGED_ARGO_PROVIDER""HOSTED_ARGO_PROVIDER"
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
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
Default "AGENT_SCOPE_UNSET"
Enum"AGENT_SCOPE_UNSET""ACCOUNT""ORG""PROJECT"
- Mock server
https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agent.identifier}
- Harness host URL
https://app.harness.io/gitops/api/v1/agents/{agent.identifier}
- Vanity URL
https://app.harness.io/gitops/api/v1/agents/{agent.identifier}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agent.identifier}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"accountIdentifier": "string",
"projectIdentifier": "string",
"orgIdentifier": "string",
"identifier": "string",
"name": "string",
"metadata": {
"namespace": "string",
"highAvailability": true,
"deployedApplicationCount": 0,
"existingInstallation": true,
"mappedProjects": {
"appProjMap": {
"property1": {
"projectIdentifier": "string",
"orgIdentifier": "string"
},
"property2": {
"projectIdentifier": "string",
"orgIdentifier": "string"
}
}
},
"infraType": "UNSET",
"isNamespaced": true
},
"description": "string",
"type": "AGENT_TYPE_UNSET",
"createdAt": {
"seconds": "string",
"nanos": 0
},
"lastModifiedAt": {
"seconds": "string",
"nanos": 0
},
"tags": {
"property1": "string",
"property2": "string"
},
"health": {
"lastHeartbeat": "2019-08-24T14:15:22Z",
"argoRepoServer": {
"status": "HEALTH_STATUS_UNSET",
"k8sError": "string",
"message": "string",
"version": "string"
},
"argoAppController": {
"status": "HEALTH_STATUS_UNSET",
"k8sError": "string",
"message": "string",
"version": "string"
},
"argoRedisServer": {
"status": "HEALTH_STATUS_UNSET",
"k8sError": "string",
"message": "string",
"version": "string"
},
"harnessGitopsAgent": {
"status": "HEALTH_STATUS_UNSET",
"k8sError": "string",
"message": "string",
"version": "string"
},
"connectionStatus": "CONNECTED_STATUS_UNSET",
"argoAppSetController": {
"status": "HEALTH_STATUS_UNSET",
"k8sError": "string",
"message": "string",
"version": "string"
}
},
"credentials": {
"privateKey": "string",
"publicKey": "string"
},
"version": {
"major": "string",
"minor": "string",
"patch": "string"
},
"upgradeAvailable": true,
"scope": "AGENT_SCOPE_UNSET",
"disasterRecoveryNode": {
"identifier": "string",
"name": "string",
"type": "UNKNOWN_TYPE"
},
"isPLG": true,
"operator": "UNKNOWN",
"prefixedIdentifier": "string"
}'A successful response.
Account Identifier for the Entity.
Project Identifier for the Entity.
Organization Identifier for the Entity.
AgentType is the type of agent. CONNECTED_ARGO_PROVIDER is deprecated and will be removed in a future release.
Please use type "MANAGED_ARGO_PROVIDER" to create your agents.
"MANAGED_ARGO_PROVIDER" agents are user managed agents and "HOSTED_ARGO_PROVIDER" agents are Harness managed agents(these cannot be created by users directly).
Default "AGENT_TYPE_UNSET"
Enum"AGENT_TYPE_UNSET""CONNECTED_ARGO_PROVIDER""MANAGED_ARGO_PROVIDER""HOSTED_ARGO_PROVIDER"
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
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
Default "AGENT_SCOPE_UNSET"
Enum"AGENT_SCOPE_UNSET""ACCOUNT""ORG""PROJECT"
Response
application/json
{ "accountIdentifier": "string", "projectIdentifier": "string", "orgIdentifier": "string", "identifier": "string", "name": "string", "metadata": { "namespace": "string", "highAvailability": true, "deployedApplicationCount": 0, "existingInstallation": true, "mappedProjects": { … }, "infraType": "UNSET", "isNamespaced": true }, "description": "string", "type": "AGENT_TYPE_UNSET", "createdAt": { "seconds": "string", "nanos": 0 }, "lastModifiedAt": { "seconds": "string", "nanos": 0 }, "tags": { "property1": "string", "property2": "string" }, "health": { "lastHeartbeat": "2019-08-24T14:15:22Z", "argoRepoServer": { … }, "argoAppController": { … }, "argoRedisServer": { … }, "harnessGitopsAgent": { … }, "connectionStatus": "CONNECTED_STATUS_UNSET", "argoAppSetController": { … } }, "credentials": { "privateKey": "string", "publicKey": "string" }, "version": { "major": "string", "minor": "string", "patch": "string" }, "upgradeAvailable": true, "scope": "AGENT_SCOPE_UNSET", "disasterRecoveryNode": { "identifier": "string", "name": "string", "type": "UNKNOWN_TYPE" }, "isPLG": true, "operator": "UNKNOWN", "prefixedIdentifier": "string" }
Query
Controls the Environment variable HELM_SECRETS_VALUES_ALLOW_PATH_TRAVERSAL to allow or deny dot-dot-slash values file paths. Disabled by default for security reasons. This config is pushed as an env variable to the repo-server.
For a Namespaced gitops agent, incluster is disabled by default. (controlled through variable cluster.inclusterEnabled in argocd-cm configmap. NOTE that you will have to manually restrict your namespaced agent's scope to its own cluster since this essentially makes the namespaced agent have access to incluster completely including creating clusterroles.
- Mock server
https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
- Harness host URL
https://app.harness.io/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
- Vanity URL
https://app.harness.io/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agentIdentifier}/deploy.yaml?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&namespace=string&disasterRecoveryIdentifier=string&skipCrds=true&caData=string&proxy.http=string&proxy.https=string&proxy.username=string&proxy.password=string&proxy.skipSSLVerify=true&privateKey=string&argocdSettings.enableHelmPathTraversal=true&argocdSettings.forceEnableInCluster=true' \
-H 'x-api-key: YOUR_API_KEY_HERE'- Mock server
https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm
- Harness host URL
https://app.harness.io/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm
- Vanity URL
https://app.harness.io/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://apidocs.harness.io/_mock/openapi-merged/gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"namespace": "string",
"disasterRecoveryIdentifier": "string",
"skipCrds": true,
"caData": "string",
"proxy": {
"http": "string",
"https": "string",
"username": "string",
"password": "string",
"skipSSLVerify": true
},
"privateKey": "string",
"argocdSettings": {
"enableHelmPathTraversal": true,
"forceEnableInCluster": true
}
}'