> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/infrastructure-as-code-management/iacm-api-reference/module-registry/list-module-metadata.md).

# List module metadata

List the module metadata from the module registry

```json
{"openapi":"3.0.3","info":{"title":"Infrastructure as Code Management","version":"0.1.0"},"tags":[{"name":"module-registry","description":"The module-registry service is a private registry for Terraform/Opentofu modules"}],"servers":[{"url":"http://localhost:80"}],"paths":{"/api/modules/{module_id}/metadata":{"get":{"tags":["module-registry"],"summary":"List module metadata","description":"List the module metadata from the module registry","operationId":"module-registry#list-metadata-by-module","parameters":[{"name":"version","in":"query","description":"version of the module","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"version of the module"}},{"name":"submodule","in":"query","description":"submodule name","allowEmptyValue":true,"schema":{"type":"string","description":"submodule name"}},{"name":"scope_org","in":"query","description":"org name","allowEmptyValue":true,"schema":{"type":"string","description":"org name"}},{"name":"scope_project","in":"query","description":"project name","allowEmptyValue":true,"schema":{"type":"string","description":"project name"}},{"name":"module_id","in":"path","description":"module id","required":true,"schema":{"type":"string","description":"module id"}},{"name":"Harness-Account","in":"header","description":"account name","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"account name"}}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModuleMetadataResponse"}}}},"400":{"description":"BadRequestError: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"401":{"description":"UnauthorizedError: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"403":{"description":"ForbiddenError: Forbidden response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"404":{"description":"NotFoundError: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"408":{"description":"TimeoutError: Request Timeout response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"409":{"description":"ConflictError: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"423":{"description":"LockedError: Locked response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"499":{"description":"ContextCancelledError:  response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"500":{"description":"InternalServerError: Internal Server Error response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}},"502":{"description":"BadGatewayError: Bad Gateway response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/RegistryError"}}}}}}}},"components":{"schemas":{"ListModuleMetadataResponse":{"type":"object","properties":{"account":{"type":"string","description":"account name"},"dependencies":{"type":"array","items":{"$ref":"#/components/schemas/DependenciesMetadata"},"description":"Dependencies of the module"},"examples_paths":{"type":"array","items":{"type":"string"},"description":"Example directories discovered for this module version"},"metadata_error":{"type":"string","description":"error while retrieving the module"},"module_version":{"type":"string","description":"module version"},"name":{"type":"string","description":"module name"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/OutputMetadata"},"description":"Outputs of the module"},"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderMetadata"},"description":"Providers of the module"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"},"description":"Resources of the module"},"scope_org":{"type":"string","description":"org name"},"scope_project":{"type":"string","description":"project name"},"submodule":{"type":"array","items":{"type":"string"},"description":"Submodules of the module"},"system":{"type":"string","description":"system name"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/VariableMetadata"},"description":"Variables of the module"}},"required":["account","name","system","module_version","outputs","providers","resources","variables"]},"DependenciesMetadata":{"type":"object","properties":{"dependency_name":{"type":"string","description":"Dependency name"},"dependency_source":{"type":"string","description":"Dependency source"},"dependency_version":{"type":"string","description":"Dependency version"}}},"OutputMetadata":{"type":"object","properties":{"output_description":{"type":"string","description":"Output description"},"output_name":{"type":"string","description":"Output name"},"output_sensitive":{"type":"boolean","description":"Output sensitivity"}}},"ProviderMetadata":{"type":"object","properties":{"provider_name":{"type":"string","description":"Provider name"},"provider_source":{"type":"string","description":"Provider source"},"provider_version":{"type":"string","description":"Provider version"}}},"ResourceMetadata":{"type":"object","properties":{"resource_name":{"type":"string","description":"Resource name"},"resource_type":{"type":"string","description":"Resource type"}}},"VariableMetadata":{"type":"object","properties":{"variable_default":{"type":"string","description":"Variable default value"},"variable_description":{"type":"string","description":"Variable description"},"variable_name":{"type":"string","description":"Variable name"},"variable_required":{"type":"boolean","description":"Is variable required"},"variable_sensitive":{"type":"boolean","description":"Is variable sensitive"},"variable_type":{"type":"string","description":"Variable type"}}},"RegistryError":{"type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?"},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem."},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem."},"name":{"type":"string","description":"Name is the name of this class of errors."},"temporary":{"type":"boolean","description":"Is the error temporary?"},"timeout":{"type":"boolean","description":"Is the error a timeout?"}},"required":["name","id","message","temporary","timeout","fault"]}}}}
```