# List module metadata

List the module metadata from the module registry

Endpoint: GET /iacm/api/modules/{module_id}/metadata
Version: 1.0
Security: x-api-key

## Query parameters:

  - `version` (string, required)
    version of the module
    Example: "Temporibus deserunt veniam et pariatur sit."

  - `submodule` (string)
    submodule name
    Example: "Omnis magnam."

  - `scope_org` (string)
    org name
    Example: "Eum ut voluptate."

  - `scope_project` (string)
    project name
    Example: "Cum inventore provident aut eaque dolorem."

## Path parameters:

  - `module_id` (string, required)
    module id
    Example: "Neque sint."

## Header parameters:

  - `Harness-Account` (string, required)
    account name
    Example: "Et reprehenderit aliquid."

## Response 200 fields (application/json):

  - `account` (string, required)
    account name
    Example: "Cumque sit quisquam et ut eius impedit."

  - `dependencies` (array)
    Dependencies of the module
    Example: [{"dependency_name":"Dolores at.","dependency_source":"Beatae aut.","dependency_version":"Velit quibusdam velit iste repudiandae perferendis."},{"dependency_name":"Dolores at.","dependency_source":"Beatae aut.","dependency_version":"Velit quibusdam velit iste repudiandae perferendis."},{"dependency_name":"Dolores at.","dependency_source":"Beatae aut.","dependency_version":"Velit quibusdam velit iste repudiandae perferendis."},{"dependency_name":"Dolores at.","dependency_source":"Beatae aut.","dependency_version":"Velit quibusdam velit iste repudiandae perferendis."}]

  - `dependencies.dependency_name` (string)
    Dependency name
    Example: "Provident error excepturi exercitationem sapiente sunt asperiores."

  - `dependencies.dependency_source` (string)
    Dependency source
    Example: "Quia sed quia voluptatem veritatis."

  - `dependencies.dependency_version` (string)
    Dependency version
    Example: "At aliquam."

  - `examples_paths` (array)
    Example directories discovered for this module version
    Example: ["Culpa et ex rerum eligendi voluptas.","Nisi eum sed reiciendis voluptas aut."]

  - `metadata_error` (string)
    error while retrieving the module
    Example: "Aspernatur impedit deleniti eaque consequuntur."

  - `module_version` (string, required)
    module version
    Example: "Voluptatem commodi eos voluptate."

  - `name` (string, required)
    module name
    Example: "Nam et nostrum quos labore odio natus."

  - `outputs` (array, required)
    Outputs of the module
    Example: [{"output_description":"Nostrum dolore est sit ut.","output_name":"Ea mollitia.","output_sensitive":false},{"output_description":"Nostrum dolore est sit ut.","output_name":"Ea mollitia.","output_sensitive":false},{"output_description":"Nostrum dolore est sit ut.","output_name":"Ea mollitia.","output_sensitive":false}]

  - `outputs.output_description` (string)
    Output description
    Example: "Et qui veritatis error eos ut voluptatem."

  - `outputs.output_name` (string)
    Output name
    Example: "Nisi dolores sunt."

  - `outputs.output_sensitive` (boolean)
    Output sensitivity

  - `providers` (array, required)
    Providers of the module
    Example: [{"provider_name":"Beatae fuga consequatur officiis exercitationem.","provider_source":"Esse dolor eligendi reprehenderit.","provider_version":"Quibusdam soluta dicta."},{"provider_name":"Beatae fuga consequatur officiis exercitationem.","provider_source":"Esse dolor eligendi reprehenderit.","provider_version":"Quibusdam soluta dicta."},{"provider_name":"Beatae fuga consequatur officiis exercitationem.","provider_source":"Esse dolor eligendi reprehenderit.","provider_version":"Quibusdam soluta dicta."}]

  - `providers.provider_name` (string)
    Provider name
    Example: "Eveniet eius voluptatum molestiae aut."

  - `providers.provider_source` (string)
    Provider source
    Example: "Unde ullam earum quia."

  - `providers.provider_version` (string)
    Provider version
    Example: "Culpa molestias aut non."

  - `resources` (array, required)
    Resources of the module
    Example: [{"resource_name":"Omnis eligendi unde.","resource_type":"Qui aut illo omnis quibusdam."},{"resource_name":"Omnis eligendi unde.","resource_type":"Qui aut illo omnis quibusdam."},{"resource_name":"Omnis eligendi unde.","resource_type":"Qui aut illo omnis quibusdam."}]

  - `resources.resource_name` (string)
    Resource name
    Example: "Delectus at odio."

  - `resources.resource_type` (string)
    Resource type
    Example: "Ut soluta aliquid."

  - `scope_org` (string)
    org name
    Example: "Repellendus quidem ratione veniam est."

  - `scope_project` (string)
    project name
    Example: "Id hic dolore soluta quo aut qui."

  - `submodule` (array)
    Submodules of the module
    Example: ["Voluptates voluptatem voluptatem.","Doloribus enim ipsum eos ducimus quidem.","Qui eum."]

  - `system` (string, required)
    system name
    Example: "Non consequatur."

  - `variables` (array, required)
    Variables of the module
    Example: [{"variable_default":"Aut incidunt maiores quam.","variable_description":"Tempora et et doloribus ullam.","variable_name":"Maiores omnis blanditiis explicabo voluptates totam.","variable_required":false,"variable_sensitive":true,"variable_type":"A sunt vel."},{"variable_default":"Aut incidunt maiores quam.","variable_description":"Tempora et et doloribus ullam.","variable_name":"Maiores omnis blanditiis explicabo voluptates totam.","variable_required":false,"variable_sensitive":true,"variable_type":"A sunt vel."}]

  - `variables.variable_default` (string)
    Variable default value
    Example: "Sit molestiae."

  - `variables.variable_description` (string)
    Variable description
    Example: "Sunt omnis quidem."

  - `variables.variable_name` (string)
    Variable name
    Example: "Rerum repellendus repellendus molestiae distinctio id."

  - `variables.variable_required` (boolean)
    Is variable required
    Example: true

  - `variables.variable_sensitive` (boolean)
    Is variable sensitive

  - `variables.variable_type` (string)
    Variable type
    Example: "Id cupiditate tempora."

## Response 400 fields (application/vnd.goa.error):

  - `fault` (boolean, required)
    Is the error a server-side fault?
    Example: true

  - `id` (string, required)
    ID is a unique identifier for this particular occurrence of the problem.
    Example: "123abc"

  - `message` (string, required)
    Message is a human-readable explanation specific to this occurrence of the problem.
    Example: "parameter 'p' must be an integer"

  - `name` (string, required)
    Name is the name of this class of errors.
    Example: "bad_request"

  - `temporary` (boolean, required)
    Is the error temporary?
    Example: true

  - `timeout` (boolean, required)
    Is the error a timeout?
    Example: true