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.
- List workspaces
List all workspace tags
Show workspace metrics
Create workspace
Destroy workspace
Show workspace
Update workspace
Force unlock workspace
List modules
List resources
List resources using selectors
Clone workspace
List data
Create data
Show data
Evaluate data
Disable drift automation for a workspace
Get drift automation status for a workspace
Enable drift automation for a workspace
Disable ephemeral TTL for a workspace
Get ephemeral TTL status for a workspace
Enable ephemeral TTL for a workspace
Send event
List pipelines
Create remote execution
Show remote execution
Download remote execution
execute-remote-execution workspaces
Upload remote execution source
List workspace resource types
Map of resource types and their attributes
List workspace resource type attributes
Delete resources
Update resources
Delete stale resources
List provisioners ratio
List workspaces associated with a template ID
List workspaces
Harness NextGen Software Delivery Platform API Reference (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, read our documentation or 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
Harness host URL
https://app.harness.io
Vanity URL
https://{vanity}
- Harness host URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspace-metrics
- Vanity URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspace-metrics
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://app.harness.io/iacm/api/orgs/2/projects/a/workspace-metrics?start_time=4988982404882760000&end_time=6586438679627230000' \
-H 'Harness-Account: 2v1' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "status_counts": { "Quo et libero ipsum necessitatibus qui temporibus.": 4752835921268047000 } }
Query
Limit is the number of records to return for a page.
Default 30
Example: limit=30
Page is the page number to return relative to the page 'limit'.
Default 1
Example: page=1
Sort order for results
Default "name,ASC"
Enum"name,ASC""name,DESC""updated,ASC""updated,DESC"
Example: sort=name,ASC
Status of the execution
Example: status=Inventore iusto temporibus et dolorum non in.&status=Omnis voluptas atque aut qui.&status=Deserunt asperiores dolores reiciendis facilis.&status=Voluptatem dolore totam.
- Harness host URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspaces
- Vanity URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspaces
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://app.harness.io/iacm/api/orgs/bc/projects/3n/workspaces?limit=30&page=1&searchTerm=mysta&sort=name%2CASC&status=Inventore+iusto+temporibus+et+dolorum+non+in.%2COmnis+voluptas+atque+aut+qui.%2CDeserunt+asperiores+dolores+reiciendis+facilis.%2CVoluptatem+dolore+totam.&tags=Mollitia+maxime+et+doloribus.%2CSunt+et+quis+voluptatem+vel+natus+non.' \
-H 'Harness-Account: 3j1' \
-H 'x-api-key: YOUR_API_KEY_HERE'OK response.
Bodyapplication/jsonArray [
Account is the internal customer account ID.
Example: "94o"
Created is the unix timestamp at which the resource was originally created in milliseconds.
Example: 99828838502601250
Description provides long-form text about the resource.
Example: "this is a more detailed explanation of the resource."
Name is the human readable name for the resource.
Example: "resource name"
The status of the workspace
Enum"active""inactive""provisioning""destroying""failed""unknown"
Example: "provisioning"
Modified is the unix timestamp at which the resource was last modified in milliseconds.
Example: 5109510937432219000
Response
application/json
[ { "account": "np", "created": 6753526141080875000, "description": "this is a more detailed explanation of the resource.", "identifier": "4", "name": "resource name", "org": "9", "project": "o", "status": "provisioning", "updated": 1329986957418801700 }, { "account": "np", "created": 6753526141080875000, "description": "this is a more detailed explanation of the resource.", "identifier": "4", "name": "resource name", "org": "9", "project": "o", "status": "provisioning", "updated": 1329986957418801700 }, { "account": "np", "created": 6753526141080875000, "description": "this is a more detailed explanation of the resource.", "identifier": "4", "name": "resource name", "org": "9", "project": "o", "status": "provisioning", "updated": 1329986957418801700 } ]
Bodyapplication/jsonrequired
AssociatedTemplate defines the template details with template_id and version.
Example: {"template_id":"s1","version":"ck"}
cost_breakdown_json is the identifier to the breakdown cost file from the current execution that was applied successfully
Example: "c4a2d99bc28d236098a095277b7eb0718d6be068"
cost_diff_json is the identifier to the diff cost file between the previous and current successful executions
Example: "c4a2d99bc28d236098a095277b7eb0718d6be068"
define if cost estimation operations will be performed in this workspace
Default false
Example: true
List of default pipelines associated with this workspace and any per-workspace overrides.
Example: {"Non et est.":{"project_pipeline":"Accusamus aut.","workspace_pipeline":"Id dolor laudantium omnis."},"Vel labore fugiat modi.":{"project_pipeline":"Accusamus aut.","workspace_pipeline":"Id dolor laudantium omnis."}}
Description provides long-form text about the resource.
Example: "this is a more detailed explanation of the resource."
list of environment variables configured on the workspace.
Example: {"Distinctio voluptatum est eius.":{"key":"f9","value":"Quo voluptas laboriosam asperiores.","value_type":"string"},"Ipsum et quis aut.":{"key":"f9","value":"Quo voluptas laboriosam asperiores.","value_type":"string"}}
modules_json is the identifier of any modules metadata associated with this workspace
Example: "c4a2d99bc28d236098a095277b7eb0718d6be068"
Name is the human readable name for the resource.
Example: "resource name"
Provider Connector is the reference to the connector for the infrastructure provider.
Example: "Et et."
define an array of provider connectors that belong to Workspace
Example: [{"connector_ref":"tm","created":1627590400,"id":5383730240656092000,"terragrunt_provider":false,"type":"azure","updated":1627686800,"workspace_id":1025464643727282800},{"connector_ref":"tm","created":1627590400,"id":5383730240656092000,"terragrunt_provider":false,"type":"azure","updated":1627686800,"workspace_id":1025464643727282800}]
providers_json is the identifier of any modules metadata associated with this workspace
Example: "c4a2d99bc28d236098a095277b7eb0718d6be068"
Provisioner defines the provisioning tool to use.
Example: "Maiores aspernatur praesentium distinctio consequatur."
Provisioner configuration metadata (key value pair provisioner specific configuration).
Example: "Tempore voluptatum veritatis."
Provisioner Version defines the tool version to use.
Default "latest"
Example: "Voluptate tempora quasi ut."
prune_sensitive_data is a flag to enable or disable pruning of sensitive data
Default false
Example: true
Repository is the name of the repository to use.
Example: "Et sequi suscipit ratione natus quis."
Repository Commit/Tag in which the code should be accessed.
Example: "abc10ed"
Repository Connector is the reference to the connector to use for this code.
Example: "Exercitationem accusantium."
Repository Path is the path in which the infra code resides.
Default ""
Example: ""
repository_submodules is the instruction about whether to clone submodules in the pipeline step
Default "false"
Enum"false""true""recursive"
Example: "recursive"
List of patterens that will be used for sparse checkout option of git clone
Example: "Alias aliquid minima facere ex commodi."
state_checksum is the sha-256 checksum of terraform state file
Example: "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f"
Tags associated with the workspace.
Example: {"cost-center":"engineering","environment":"production","team":"platform"}
terraform_plan_json is the identifier to the current state file only in JSON format.
Example: "f9e21473daaa2674d862b67a1339f4570e86de17"
terraform_state is the identifier to the plan file used to create the latest state.
Example: "fc1200c7a7aa52109d762a9f005b149abef01479"
terraform_state_json is the identifier to the plan file used to create the latest state only in JSON format.
Example: "c4a2d99bc28d236098a095277b7eb0718d6be068"
define an array of terraform variables files that belong to a different repository
Example: [{"repository":"Quis at et accusamus.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Et veniam asperiores qui explicabo iure et.","repository_path":"","repository_sha":"abc10ed"},{"repository":"Quis at et accusamus.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Et veniam asperiores qui explicabo iure et.","repository_path":"","repository_sha":"abc10ed"},{"repository":"Quis at et accusamus.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Et veniam asperiores qui explicabo iure et.","repository_path":"","repository_sha":"abc10ed"},{"repository":"Quis at et accusamus.","repository_branch":"main","repository_commit":"abc10ed","repository_connector":"Et veniam asperiores qui explicabo iure et.","repository_path":"","repository_sha":"abc10ed"}]
list of terraform variables configured on the workspace.
Example: {"Id reprehenderit nostrum eveniet eveniet.":{"key":"f9","value":"Quo voluptas laboriosam asperiores.","value_type":"string"},"Soluta quos inventore aut.":{"key":"f9","value":"Quo voluptas laboriosam asperiores.","value_type":"string"}}
Whether this workspace uses terragrunt to provision infrastructure
Default false
Example: true
Terragrunt Version to use when provisioner is terragrunt.
Example: "Mollitia quos numquam quas."
- Harness host URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspaces
- Vanity URLhttps://app.harness.io/iacm/api/orgs/{org}/projects/{project}/workspaces
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://app.harness.io/iacm/api/orgs/o9/projects/g/workspaces \
-H 'Content-Type: application/json' \
-H 'Harness-Account: jp0' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"associated_template": {
"template_id": "7",
"version": "6"
},
"budget": 0.7937008,
"cost_breakdown_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_diff_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"cost_estimation_enabled": true,
"default_pipelines": {
"Aliquam iste sapiente fuga velit.": {
"project_pipeline": "Accusamus aut.",
"workspace_pipeline": "Id dolor laudantium omnis."
}
},
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Consequatur repellat commodi qui perspiciatis excepturi quia.": {
"key": "f9",
"value": "Quo voluptas laboriosam asperiores.",
"value_type": "string"
}
},
"id": 7821711501694201000,
"identifier": "lf",
"modules_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"name": "resource name",
"provider_connector": "Amet id dicta omnis expedita quae.",
"provider_connectors": [
{
"connector_ref": "tm",
"created": 1627590400,
"id": 5383730240656092000,
"terragrunt_provider": false,
"type": "azure",
"updated": 1627686800,
"workspace_id": 1025464643727282800
},
{
"connector_ref": "tm",
"created": 1627590400,
"id": 5383730240656092000,
"terragrunt_provider": false,
"type": "azure",
"updated": 1627686800,
"workspace_id": 1025464643727282800
}
],
"providers_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"provisioner": "Veniam consequatur et facere.",
"provisioner_configuration": "At quia harum exercitationem non.",
"provisioner_version": "Laboriosam iure excepturi quam.",
"prune_sensitive_data": true,
"repository": "Ut et id optio voluptatem quasi.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Sint hic sit libero ea maiores aut.",
"repository_path": "",
"repository_sha": "abc10ed",
"repository_submodules": "recursive",
"run_all": true,
"sparse_checkout": "Autem numquam incidunt nesciunt quas.",
"state_checksum": "d21c1662d8ce2c74f24efdc8db93eb34473b86810aeccca4b1518f70b0ccde8f",
"tags": {
"cost-center": "engineering",
"environment": "production",
"team": "platform"
},
"terraform_plan_json": "f9e21473daaa2674d862b67a1339f4570e86de17",
"terraform_state": "fc1200c7a7aa52109d762a9f005b149abef01479",
"terraform_state_json": "c4a2d99bc28d236098a095277b7eb0718d6be068",
"terraform_variable_files": [
{
"repository": "Quis at et accusamus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Et veniam asperiores qui explicabo iure et.",
"repository_path": "",
"repository_sha": "abc10ed"
},
{
"repository": "Quis at et accusamus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Et veniam asperiores qui explicabo iure et.",
"repository_path": "",
"repository_sha": "abc10ed"
}
],
"terraform_variables": {
"Debitis alias incidunt architecto fugiat nemo.": {
"key": "f9",
"value": "Quo voluptas laboriosam asperiores.",
"value_type": "string"
},
"Nesciunt ut eos ut iste.": {
"key": "f9",
"value": "Quo voluptas laboriosam asperiores.",
"value_type": "string"
}
},
"terragrunt_provider": false,
"terragrunt_version": "Dolorum velit et porro.",
"variable_sets": [
"Ex ab adipisci.",
"Corrupti dicta ad illo cupiditate accusantium."
]
}'OK response.
The result of a single evaluation
Example: {"account_id":"XRQAjvT37acOiXx9PRaQMF","action":"onrun","created":1636370209475,"details":[{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674},{"account_id":"eBqAoNchMLKigC_qZ5EdC","action":"onrun","created":1636669297674,"description":"Captures critical production policies","details":[{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"},{"deny_messages":["deployment stage 'example-stage' does not have a HarnessApproval step","deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"],"output":"{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}","policy":{"account_id":"eBqAoNchMLKigC_qZ5EdC","created":1636669297674,"identifier":"policy-1","name":"Pipeline Approval","org_id":"test-org","project_id":"test-project","rego":"","updated":1636669297674},"rego_error":"policy.rego:25: rego_parse_error: non-terminated string m == \"test","status":"error"}],"enabled":true,"identifier":"policyset-1","name":"Production Policies","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline","updated":1636669297674}],"entity":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","entity_metadata":"7bbca5d4-e9f2-4955-9b2a-019ec4d3645e","id":123,"input":"","org_id":"test-org","project_id":"test-project","status":"error","type":"pipeline,service"}
Response
application/json
{ "policy_evaluation": { "account_id": "XRQAjvT37acOiXx9PRaQMF", "action": "onrun", "created": 1636370209475, "details": [ … ], "entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e", "entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e", "id": 123, "input": "", "org_id": "test-org", "project_id": "test-project", "status": "error", "type": "pipeline,service" } }