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 Module Registry API

The module-registry service is a private registry for Terraform/Opentofu modules

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

Tagged areas include module-registry. 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 35 operations across 27 paths, and defines 42 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}.

35 operations 27 paths 42 schemas 4 DELETE15 GET13 POST3 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 Module Registry 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 35

Across 27 paths, the API surfaces 35 operations — 4 DELETE, 15 GET, 13 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

module-registry 35

The module-registry service is a private registry for Terraform/Opentofu modules

GET
/iacm/api/modules
List modules
module-registry#list_modules-by-account 8 params → 200400401403404408409423
POST
/iacm/api/modules
Create module
module-registry#create-module 3 params body → 200400401403404408409423
DELETE
/iacm/api/modules/{id}
Delete module
module-registry#delete-module 4 params → 204400401403404408409423
GET
/iacm/api/modules/{id}
List module by id
module-registry#list-modules-by-id 4 params → 200400401403404408409423
PUT
/iacm/api/modules/{id}
Update module
module-registry#update-module 4 params body → 200400401403404408409423
DELETE
/iacm/api/modules/{id}/lifecycle
Delete module lifecycle rule
module-registry#delete-module-lifecycle 4 params → 204400401403404408409423
GET
/iacm/api/modules/{id}/lifecycle
Get module lifecycle rule
module-registry#get-module-lifecycle 4 params → 200400401403404408409423
PUT
/iacm/api/modules/{id}/lifecycle
Upsert module lifecycle rule
module-registry#put-module-lifecycle 4 params body → 200400401403404408409423
GET
/iacm/api/modules/{id}/lifecycle/versions/{version}
Get module version lifecycle status
module-registry#get-module-lifecycle-version-status 5 params → 200400401403404408409423
POST
/iacm/api/modules/{id}/pipeline
Create testing pipeline
module-registry#create-testing-pipelines 4 params body → 201400401403404408409423
POST
/iacm/api/modules/{id}/sync
Sync module metadata
module-registry#sync-module-metadata 4 params → 204400401403404408409423
GET
/iacm/api/modules/{id}/tags
List module tags
module-registry#list-module-tags-by-id 4 params → 200400401403404408409423
DELETE
/iacm/api/modules/{id}/testing
Disable testing
module-registry#disable-testing 4 params → 204400401403404408409423
POST
/iacm/api/modules/{id}/testing
Enable testing
module-registry#enable-testing 4 params body → 204400401403404408409423
PUT
/iacm/api/modules/{id}/testing
Update module testing
module-registry#update-module-testing 4 params body → 200400401403404408409423
DELETE
/iacm/api/modules/{id}/versions/{version}
Delete module version
module-registry#delete-module-versions 5 params → 204400401403404408409423
GET
/iacm/api/modules/{module_id}/examples/file
Get module example file
module-registry#get-module-example-file 6 params → 200400401403404408409423
GET
/iacm/api/modules/{module_id}/examples/tree
List module example tree
module-registry#list-module-example-tree 6 params → 200400401403404408409423
GET
/iacm/api/modules/{module_id}/metadata
List module metadata
module-registry#list-metadata-by-module 6 params → 200400401403404408409423
GET
/iacm/api/modules/{module_id}/readme
List module readme
module-registry#list-readme-by-id 6 params → 200400401403404408409423
POST
/iacm/api/modules/{moduleId}/events
Send an event related with a module execution
module-registry#send-module-event 1 param body → 200400401403404408409423
GET
/iacm/api/modules/{moduleId}/executions
List executions for a specific module
module-registry#list-module-executions-id 11 params → 200400401403404408409423
POST
/iacm/api/modules/{moduleId}/executions
Create a new module execution
module-registry#create-module-execution 1 param body → 200400401403404408409423
POST
/iacm/api/modules/{name}/{system}/{version}/examples
Create module example
module-registry#post-module-example 9 params → 201400401403404408409423
POST
/iacm/api/modules/{name}/{system}/{version}/metadata
Create module data
module-registry#module-parsed-data 6 params body → 201400401403404408409423
POST
/iacm/api/modules/{name}/{system}/{version}/readme
Create module readme
module-registry#post-module-readme 8 params → 201400401403404408409423
POST
/iacm/api/modules/{name}/{system}/{version}/upload
Upload module artifact files
module-registry#post-module-artifact 7 params → 201400401403404408409423
POST
/iacm/api/modules/{name}/{system}/tags
Create module tags
module-registry#post-module-tags 5 params body → 201400401403404408409423
GET
/iacm/api/modules/connectors
List connectors
module-registry#list-connectors 3 params → 200400401403404408409423
POST
/iacm/api/modules/lifecycle/batch-check
Batch check module lifecycle status
module-registry#batch-check-module-lifecycle 1 param body → 200400401403404408409423
POST
/iacm/api/modules/pipeline/onboarding
Create onboarding pipeline
module-registry#create-onboarding-pipeline 3 params body → 201400401403404408409423
GET
/iacm/api/modules/providers
List module providers
module-registry#list-module-providers 3 params → 200400401403404408409423
GET
/iacm/registry/account/{namespace}/{name}/{system}/{version}/download
Download module
module-registry#download 4 params → 200400401403404408409423
GET
/iacm/registry/account/{namespace}/{name}/{system}/{version}/download/file
Download module file tarball
module-registry#getModule 5 params → 200400401403404408409423
GET
/iacm/registry/account/{namespace}/{name}/{system}/versions
List module versions
module-registry#list-versions 3 params → 200400401403404408409423

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ListModuleByIDResponse (33 properties), ModuleResource (32 properties), ModuleRegistryCreateModuleResponseBody (18 properties), UpdateModuleRequest (17 properties). Each schema is shown below with its type and property counts.

UpdateTestingRequest
object
7 properties 4 required
ModuleExecutionResourceCollection
array
HarnessIacmModuleexecutionresource
object
ModuleExecutionResource is the representation for a single module execution.
8 properties 11 required
EnableTestingRequest
object
7 properties 4 required
PutModuleLifecycleResponse
object
6 properties 5 required
ModuleLifecycleOverride
object
Manual lifecycle tier override for a specific module version
3 properties 2 required
ListModuleExampleTreeResponse
object
1 property 1 required
CreateModuleRequest
object
17 properties 2 required
ListModuleVersionsResponse
object
1 property 1 required
ModuleLifecycleBatchCheckResult
object
Lifecycle check result for a single module item
7 properties 6 required
ProviderMetadata
object
3 properties
BatchCheckModuleLifecycleResponse
object
1 property 1 required
CreateTestingPipelineRequest
object
3 properties 2 required
IaCMError
object
6 properties 6 required
ListModuleByIDResponse
object
33 properties 7 required
ExampleTreeItem
object
3 properties 3 required
DownloadModuleResponse
object
1 property
HarnessIacmModuleRegistryModuleTestingMetadata
object
8 properties 7 required
ModuleTestingMetadata
object
ModuleTestingMetadata result type (default view)
8 properties 7 required
ModuleLifecycleBatchCheckItem
object
A single module item to check lifecycle status for
4 properties 4 required
SendModuleEventRequest
object
5 properties 4 required
HarnessIacmModuleRegistryVersionTypes
object
Returns the moduleversion and gitversion for a specific module
2 properties 2 required
HarnessIacmModuleRegistryVersions
object
Versions returns the list of versions for a given module
1 property 1 required
ModuleExecutionMetadata
object
6 properties
UpdateModuleRequest
object
17 properties 2 required
GetModuleLifecycleVersionStatusResponse
object
3 properties 2 required
ModuleResource
object
ModuleResource result type (default view)
32 properties 7 required
DependenciesMetadata
object
3 properties
CreateModuleTagsRequest
object
2 properties
CreateModuleExecutionResponse
object
8 properties 11 required
GetModuleLifecycleResponse
object
6 properties 5 required
ModuleLifecycleRule
object
Lifecycle rule configuration for a module registry module
6 properties 5 required
BatchCheckModuleLifecycleRequest
object
1 property 1 required
CreateModuleDataRequest
object
8 properties 3 required
CreateModuleExecutionRequest
object
7 properties 6 required
CreateOnboardingPipelineRequest
object
2 properties 2 required
ModuleResourceCollection
array
ModuleResourceCollection is the result type for an array of ModuleResource (default view)
OutputMetadata
object
3 properties
ListModuleMetadataResponse
object
14 properties 8 required
ModuleRegistryCreateModuleResponseBody
object
Create-ModuleResponseBody result type (default view)
18 properties 6 required
VariableMetadata
object
6 properties
ResourceMetadata
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-module-registry-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 Module Registry 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.