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 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}
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
Filter results by partial name or provider match
Default ""
Example: searchTerm=mymod
Sort order for results
Default "name,ASC"
Enum"name,ASC""name,DESC""updated,ASC""updated,DESC"
Example: sort=name,ASC
- Harness host URLhttps://app.harness.io/iacm/api/modules
- Vanity URLhttps://app.harness.io/iacm/api/modules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://app.harness.io/iacm/api/modules?limit=30&page=1&searchTerm=mymod&sort=name%2CASC&scope_org=Libero+qui+dolorum+velit+eum.&scope_project=Vel+perferendis.' \
-H 'Harness-Account: Quia voluptas optio.' \
-H 'x-api-key: YOUR_API_KEY_HERE'OK response.
Bodyapplication/jsonArray [
Harness account ID that owns the module.
Example: "abc123DEFghiJKL"
Created is the unix timestamp at which the resource was originally created in milliseconds.
Example: 7994017198742473000
Free-form text describing the purpose and usage of the module.
Example: "Provisions a VPC with public and private subnets."
Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'.
Example: "module-name-*"
error while retrieving the module
Example: "Necessitatibus qui ipsa molestiae et."
Human-readable name of the module. Must be unique within the same scope and system.
Example: "my-vpc-module"
Namespace derived from account, org and project for use with the Terraform module registry
Example: "Sapiente voluptates corporis dignissimos."
Identifier of the Harness pipeline used for module onboarding and metadata sync.
Example: "Module_Onboarding_Pipeline"
Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided.
Example: "my_org"
Project where the onboarding pipeline is defined. Defaults to scope_project if not provided.
Example: "my_project"
When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed.
Default false
Example: true
Organization identifier where the Git connector is defined. Defaults to scope_org if not provided.
Example: "my_org"
Project identifier where the Git connector is defined. Defaults to scope_project if not provided.
Example: "my_project"
Name of the Git repository that contains the module source code.
Example: "my-terraform-modules"
Repository Commit/Tag in which the code should be accessed.
Example: "abc10ed"
Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source.
Example: "my_github_connector"
Repository Path is the path in which the infra code resides.
Default ""
Example: ""
Organization identifier where the module is scoped.
Example: "my_org"
Project identifier where the module is scoped.
Example: "my_project"
Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files.
Default "git_reference"
Enum"git_reference""artifact"
Example: "git_reference"
Synced is the unix timestamp at which the resource was synced for the last time in milliseconds.
Example: 7305901217115003000
Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes).
Example: "aws"
Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws).
Example: "Qui qui reiciendis soluta incidunt quia nihil."
ModuleTestingMetadata result type (default view)
Example: {"account":"z","org":"st","pipelines":["Eos eos et.","Modi nemo sunt.","Nihil magni itaque consequatur ad consequatur.","Non sed."],"project":"is","provider_connector":"Temporibus fuga cumque.","provisioner_type":"Minus itaque aut.","provisioner_version":"Fugiat eum atque vitae.","release_pipeline":"Error explicabo."}
Modified is the unix timestamp at which the resource was last modified in milliseconds.
Example: 8390749763235943000
versions
Example: ["Quidem itaque maiores.","Recusandae ut.","Quia cupiditate consectetur quis.","Impedit sed necessitatibus dolores."]
Response
application/json
[ { "account": "abc123DEFghiJKL", "created": 6847120836514010000, "description": "Provisions a VPC with public and private subnets.", "domain_prefix": "Eum vero quod natus hic.", "git_tag_style": "module-name-*", "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff", "module_error": "Et aut.", "name": "my-vpc-module", "namespace": "Occaecati possimus sit adipisci.", "onboarding_pipeline": "Module_Onboarding_Pipeline", "onboarding_pipeline_org": "my_org", "onboarding_pipeline_project": "my_project", "onboarding_pipeline_sync": true, "org": "my_org", "project": "my_project", "repository": "my-terraform-modules", "repository_branch": "main", "repository_commit": "abc10ed", "repository_connector": "my_github_connector", "repository_path": "", "repository_url": "Vel recusandae rerum distinctio ut similique itaque.", "scope_org": "my_org", "scope_project": "my_project", "storage_type": "artifact", "synced": 2890799827884506000, "system": "aws", "tags": "Quam quia qui voluptate qui quod nihil.", "testing_enabled": true, "testing_metadata": { … }, "updated": 2193838267582118400, "versions": [ … ] }, { "account": "abc123DEFghiJKL", "created": 6847120836514010000, "description": "Provisions a VPC with public and private subnets.", "domain_prefix": "Eum vero quod natus hic.", "git_tag_style": "module-name-*", "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff", "module_error": "Et aut.", "name": "my-vpc-module", "namespace": "Occaecati possimus sit adipisci.", "onboarding_pipeline": "Module_Onboarding_Pipeline", "onboarding_pipeline_org": "my_org", "onboarding_pipeline_project": "my_project", "onboarding_pipeline_sync": true, "org": "my_org", "project": "my_project", "repository": "my-terraform-modules", "repository_branch": "main", "repository_commit": "abc10ed", "repository_connector": "my_github_connector", "repository_path": "", "repository_url": "Vel recusandae rerum distinctio ut similique itaque.", "scope_org": "my_org", "scope_project": "my_project", "storage_type": "artifact", "synced": 2890799827884506000, "system": "aws", "tags": "Quam quia qui voluptate qui quod nihil.", "testing_enabled": true, "testing_metadata": { … }, "updated": 2193838267582118400, "versions": [ … ] }, { "account": "abc123DEFghiJKL", "created": 6847120836514010000, "description": "Provisions a VPC with public and private subnets.", "domain_prefix": "Eum vero quod natus hic.", "git_tag_style": "module-name-*", "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff", "module_error": "Et aut.", "name": "my-vpc-module", "namespace": "Occaecati possimus sit adipisci.", "onboarding_pipeline": "Module_Onboarding_Pipeline", "onboarding_pipeline_org": "my_org", "onboarding_pipeline_project": "my_project", "onboarding_pipeline_sync": true, "org": "my_org", "project": "my_project", "repository": "my-terraform-modules", "repository_branch": "main", "repository_commit": "abc10ed", "repository_connector": "my_github_connector", "repository_path": "", "repository_url": "Vel recusandae rerum distinctio ut similique itaque.", "scope_org": "my_org", "scope_project": "my_project", "storage_type": "artifact", "synced": 2890799827884506000, "system": "aws", "tags": "Quam quia qui voluptate qui quod nihil.", "testing_enabled": true, "testing_metadata": { … }, "updated": 2193838267582118400, "versions": [ … ] } ]
Bodyapplication/jsonrequired
Free-form text describing the purpose and usage of the module.
Example: "Provisions a VPC with public and private subnets."
Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'.
Example: "module-name-*"
Human-readable name of the module. Must be unique within the same scope and system.
Example: "my-vpc-module"
Identifier of the Harness pipeline used for module onboarding and metadata sync.
Example: "Module_Onboarding_Pipeline"
Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided.
Example: "my_org"
Project where the onboarding pipeline is defined. Defaults to scope_project if not provided.
Example: "my_project"
When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed.
Default false
Example: true
Organization identifier where the Git connector is defined. Defaults to scope_org if not provided.
Example: "my_org"
Project identifier where the Git connector is defined. Defaults to scope_project if not provided.
Example: "my_project"
Name of the Git repository that contains the module source code.
Example: "my-terraform-modules"
Repository Commit/Tag in which the code should be accessed.
Example: "abc10ed"
Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source.
Example: "my_github_connector"
Repository Path is the path in which the infra code resides.
Default ""
Example: ""
Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files.
Default "git_reference"
Enum"git_reference""artifact"
Example: "artifact"
Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes).
Example: "aws"
- Harness host URLhttps://app.harness.io/iacm/api/modules
- Vanity URLhttps://app.harness.io/iacm/api/modules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://app.harness.io/iacm/api/modules?scope_org=my_org&scope_project=my_project' \
-H 'Content-Type: application/json' \
-H 'Harness-Account: abc123DEFghiJKL' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"description": "Provisions a VPC with public and private subnets.",
"git_tag_style": "module-name-*",
"name": "my-vpc-module",
"onboarding_pipeline": "Module_Onboarding_Pipeline",
"onboarding_pipeline_org": "my_org",
"onboarding_pipeline_project": "my_project",
"onboarding_pipeline_sync": true,
"org": "my_org",
"project": "my_project",
"repository": "my-terraform-modules",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my_github_connector",
"repository_path": "",
"storage_type": "artifact",
"system": "aws",
"tags": "Facilis quia a."
}'OK response.
Harness account ID that owns the module.
Example: "abc123DEFghiJKL"
Created is the unix timestamp at which the resource was originally created in milliseconds.
Example: 9089589250226551000
Free-form text describing the purpose and usage of the module.
Example: "Provisions a VPC with public and private subnets."
Human-readable name of the module. Must be unique within the same scope and system.
Example: "my-vpc-module"
Organization identifier where the Git connector is defined. Defaults to scope_org if not provided.
Example: "my_org"
Project identifier where the Git connector is defined. Defaults to scope_project if not provided.
Example: "my_project"
Name of the Git repository that contains the module source code.
Example: "my-terraform-modules"
Repository Commit/Tag in which the code should be accessed.
Example: "abc10ed"
Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source.
Example: "my_github_connector"
Repository Path is the path in which the infra code resides.
Default ""
Example: ""
Organization identifier where the module is scoped.
Example: "my_org"
Project identifier where the module is scoped.
Example: "my_project"
Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files.
Default "git_reference"
Enum"git_reference""artifact"
Example: "artifact"
Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes).
Example: "aws"
Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws).
Example: "Voluptatum officia aliquam."
Response
application/json
{ "account": "abc123DEFghiJKL", "created": 8124988946077168000, "description": "Provisions a VPC with public and private subnets.", "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff", "name": "my-vpc-module", "org": "my_org", "project": "my_project", "repository": "my-terraform-modules", "repository_branch": "main", "repository_commit": "abc10ed", "repository_connector": "my_github_connector", "repository_path": "", "scope_org": "my_org", "scope_project": "my_project", "storage_type": "artifact", "system": "aws", "tags": "Tempora blanditiis libero deserunt omnis.", "updated": 5792927959265118000 }
- Harness host URLhttps://app.harness.io/iacm/api/modules/{id}
- Vanity URLhttps://app.harness.io/iacm/api/modules/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://app.harness.io/iacm/api/modules/Asperiores totam omnis laudantium distinctio.?scope_org=Et+recusandae+omnis+velit.&scope_project=Eaque+molestias.' \
-H 'Harness-Account: Ut dolores debitis amet omnis voluptates dolore.' \
-H 'x-api-key: YOUR_API_KEY_HERE'