module-registry

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

list_modules-by-account module-registry

List all modules from the module registry

Securityx-api-key

Request

query Parameters

limit	integer <int64> [ 1 .. 1000 ] Default: 30 Limit is the number of records to return for a page. Example: limit=30
page	integer <int64> >= 1 Default: 1 Page is the page number to return relative to the page 'limit'. Example: page=1
searchTerm	string Default: "" Filter results by partial name match Example: searchTerm=mymod
sort	string Default: "name,ASC" Sort order for results Enum: "name,ASC" "name,DESC" "updated,ASC" "updated,DESC" Example: sort=updated,DESC

header Parameters

Harness-Account

required

string

account name

Example: Voluptatem est quia odio ea natus voluptatem.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "t",
"created": 8993758103719388000,
"description": "Ut doloremque nihil nam doloribus consectetur delectus.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Illo dignissimos qui et.",
"name": "y",
"repository": "Provident mollitia et cumque asperiores exercitationem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolorum adipisci sit magnam cum.",
"repository_path": "",
"repository_url": "Aut qui impedit cupiditate.",
"synced": 4518957871894128000,
"system": "f",
"tags": "Id fuga ratione sit fuga quis pariatur.",
"updated": 1402747289426212000,
"versions": ["Quisquam expedita id quasi.",
"Sit unde est laboriosam.",
"Velit magnam."
]
},
{"account": "t",
"created": 8993758103719388000,
"description": "Ut doloremque nihil nam doloribus consectetur delectus.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Illo dignissimos qui et.",
"name": "y",
"repository": "Provident mollitia et cumque asperiores exercitationem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolorum adipisci sit magnam cum.",
"repository_path": "",
"repository_url": "Aut qui impedit cupiditate.",
"synced": 4518957871894128000,
"system": "f",
"tags": "Id fuga ratione sit fuga quis pariatur.",
"updated": 1402747289426212000,
"versions": ["Quisquam expedita id quasi.",
"Sit unde est laboriosam.",
"Velit magnam."
]
}
]

create-module module-registry

Create a new module in the module registry

Securityx-api-key

Request

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: 5m

Request Body schema: application/json
required

description	string description of the module
name required	string [ 1 .. 128 ] characters module name
repository	string Repository is the name of the repository to use.
repository_branch	string Repository Branch in which the code should be accessed.
repository_commit	string Repository Commit/Tag in which the code should be accessed.
repository_connector	string Repository Connector is the reference to the connector to use for this code.
repository_path	string Default: "" Repository Path is the path in which the infra code resides.
system required	string [ 1 .. 128 ] characters ^[a-z]+$ system name
tags	string tags defining the module

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/modules

Request samples

Payload
curl
Java
Go

application/json

{"description": "Vitae molestiae.",
"name": "3",
"repository": "Quam cum maiores.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Sequi distinctio qui.",
"repository_path": "",
"system": "4c9",
"tags": "Ad consequatur ducimus."
}

Response samples

application/json

{"account": "7",
"created": 7690371654835114000,
"description": "Sit est.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "30",
"repository": "Eaque iure ipsa sint corporis soluta.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Quisquam qui qui qui et.",
"repository_path": "",
"system": "luk",
"tags": "Nostrum tempore porro.",
"updated": 942494768296950900
}

delete-module module-registry

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Minima hic commodi.

header Parameters

Harness-Account

required

string

account name

Example: Molestiae expedita ullam.

Responses

204

No Content response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

delete/iacm/api/modules/{id}

Request samples

curl
Java
Go

list-modules-by-id module-registry

List a module from the module registry by ID

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Eligendi sed aut omnis numquam officiis expedita.

header Parameters

Harness-Account

required

string

account name

Example: Excepturi ipsam qui sed illo.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "j",
"created": 6877344033856126000,
"description": "Molestiae autem consequatur incidunt.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Quam rerum.",
"name": "ywz",
"repository": "Rerum quibusdam libero dolores.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Voluptas porro neque ab velit natus nobis.",
"repository_path": "",
"repository_url": "Officiis sed nesciunt est non sunt sed.",
"synced": 2092421298572285400,
"system": "sx",
"tags": "Voluptatem ut officia consectetur et.",
"updated": 185878032558311940,
"versions": ["Explicabo omnis beatae odit minus minima eum.",
"Deserunt in.",
"Beatae dolore est libero nihil.",
"Similique non animi maxime."
]
}

update-module module-registry

Update a module in the module registry

Securityx-api-key

Request

path Parameters

required

string

module id

Example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: tf6

Request Body schema: application/json
required

description	string description of the module
name required	string [ 1 .. 128 ] characters module name
repository	string Repository is the name of the repository to use.
repository_branch	string Repository Branch in which the code should be accessed.
repository_commit	string Repository Commit/Tag in which the code should be accessed.
repository_connector	string Repository Connector is the reference to the connector to use for this code.
repository_path	string Default: "" Repository Path is the path in which the infra code resides.
system required	string [ 1 .. 128 ] characters ^[a-z]+$ system name
tags	string tags defining the module

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

put/iacm/api/modules/{id}

Request samples

Payload
curl
Java
Go

application/json

{"description": "Architecto repudiandae est.",
"name": "6",
"repository": "Totam a quae enim molestiae porro totam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Molestias assumenda necessitatibus debitis vero rerum incidunt.",
"repository_path": "",
"system": "hu",
"tags": "Hic accusantium odio nesciunt."
}

sync-module-metadata module-registry

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Minima maxime sequi culpa alias.

header Parameters

Harness-Account

required

string

account name

Example: Earum non rerum.

Responses

204

No Content response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/modules/{id}/sync

Request samples

curl
Java
Go

list-metadata-by-module module-registry

List the module metadata from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Accusantium vel voluptas veritatis repellat.

query Parameters

version required	string version of the module Example: version=Est incidunt autem quis dolorem nostrum libero.
submodule	string submodule name Example: submodule=Est nisi aut vitae dolorem.

header Parameters

Harness-Account

required

string

account name

Example: Non atque.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules/{module_id}/metadata

Request samples

curl
Java
Go

Response samples

application/json

{"account": "Sunt eos quia sapiente.",
"dependencies": [{"dependency_name": "Illum beatae molestiae.",
"dependency_source": "Non quaerat dicta praesentium occaecati.",
"dependency_version": "Delectus reiciendis vel facere ratione alias qui."
},
{"dependency_name": "Illum beatae molestiae.",
"dependency_source": "Non quaerat dicta praesentium occaecati.",
"dependency_version": "Delectus reiciendis vel facere ratione alias qui."
}
],
"metadata_error": "Eum ut.",
"module_version": "In qui tempore.",
"name": "Ut repudiandae dolore eos nulla.",
"outputs": [{"output_description": "Enim exercitationem cupiditate deserunt.",
"output_name": "Aut est qui minus aut fugiat neque.",
"output_sensitive": true
},
{"output_description": "Enim exercitationem cupiditate deserunt.",
"output_name": "Aut est qui minus aut fugiat neque.",
"output_sensitive": true
}
],
"providers": [{"provider_name": "Enim est possimus quas.",
"provider_source": "Eveniet cum officiis eius.",
"provider_version": "Consequatur sit quae cupiditate officia magnam voluptates."
},
{"provider_name": "Enim est possimus quas.",
"provider_source": "Eveniet cum officiis eius.",
"provider_version": "Consequatur sit quae cupiditate officia magnam voluptates."
},
{"provider_name": "Enim est possimus quas.",
"provider_source": "Eveniet cum officiis eius.",
"provider_version": "Consequatur sit quae cupiditate officia magnam voluptates."
},
{"provider_name": "Enim est possimus quas.",
"provider_source": "Eveniet cum officiis eius.",
"provider_version": "Consequatur sit quae cupiditate officia magnam voluptates."
}
],
"resources": [{"resource_name": "Vel veniam accusantium est quia.",
"resource_type": "Voluptatem quidem eaque quam non ipsa."
},
{"resource_name": "Vel veniam accusantium est quia.",
"resource_type": "Voluptatem quidem eaque quam non ipsa."
},
{"resource_name": "Vel veniam accusantium est quia.",
"resource_type": "Voluptatem quidem eaque quam non ipsa."
},
{"resource_name": "Vel veniam accusantium est quia.",
"resource_type": "Voluptatem quidem eaque quam non ipsa."
}
],
"submodule": ["Ullam saepe.",
"Debitis voluptas aliquam voluptate cupiditate tempore."
],
"system": "Perspiciatis cupiditate molestiae cum et illum aliquid.",
"variables": [{"variable_default": "Aut omnis ut nam sit.",
"variable_description": "Ut est.",
"variable_name": "Atque ipsum qui.",
"variable_required": true,
"variable_sensitive": false,
"variable_type": "Maxime praesentium eum alias sunt nihil accusantium."
},
{"variable_default": "Aut omnis ut nam sit.",
"variable_description": "Ut est.",
"variable_name": "Atque ipsum qui.",
"variable_required": true,
"variable_sensitive": false,
"variable_type": "Maxime praesentium eum alias sunt nihil accusantium."
}
]
}

list-readme-by-id module-registry

List the module readme from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Blanditiis numquam veniam sapiente suscipit dolorum ut.

query Parameters

version required	string version of the module Example: version=At ut natus exercitationem.
submodule	string submodule name Example: submodule=At quo et ut et.

header Parameters

Harness-Account

required

string

account name

Example: Aliquam in sit dolore.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules/{module_id}/readme

Request samples

curl
Java
Go

Response samples

application/json

"string"

module-parsed-data module-registry

Create a new module in the module registry

Securityx-api-key

Request

path Parameters

name required	string module name Example: Sunt laboriosam.
system required	string system name Example: Enim doloremque ullam voluptate ut eum quo.
version required	string version of the module Example: Incidunt quo.

header Parameters

Harness-Account

required

string

account name

Example: Et dolores quia iusto.

Request Body schema: application/json
required

download_url required	string download url of the module
	object error from the tag operation
git_tag required	string git tag of the module
metadata required	string metadata to be parsed
repo_url	string url pointing to the repo
submodule_name	string name of the submodule been processed
submodule_paths	Array of strings path of the submodules relative to the module

Responses

201

Created response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/modules/{name}/{system}/{version}/metadata

Request samples

Payload
curl
Java
Go

application/json

{"download_url": "Facere debitis perferendis.",
"error": {"Et fugit ipsa itaque tempore.": "Ut et.",
"Inventore accusamus qui qui.": "Consequatur libero.",
"Non vel praesentium.": "Qui rerum voluptatem."
},
"git_tag": "Harum iure beatae et.",
"metadata": "Inventore ut totam autem eveniet et.",
"repo_url": "Et amet perspiciatis assumenda eveniet libero.",
"submodule_name": "Aut vel accusamus.",
"submodule_paths": ["Et rem sed voluptatem praesentium numquam adipisci.",
"Voluptatem vero expedita laborum alias quod molestiae."
]
}

post-module-readme module-registry

Endpoint to push the Readme for a given module

Securityx-api-key

Request

path Parameters

name required	string module name Example: Dicta sed hic soluta aut molestias nostrum.
system required	string system name Example: Non tenetur officiis nemo.
version required	string version of the module Example: Error ab voluptatum.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Est laborum dolores repellat.

header Parameters

Harness-Account

required

string

account name

Example: Quam quaerat.

Responses

201

Created response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/modules/{name}/{system}/{version}/readme

Request samples

curl
Java
Go

post-module-tags module-registry

List all tags for a given module

Securityx-api-key

Request

path Parameters

name required	string [ 1 .. 128 ] characters module name Example: vh2
system required	string [ 1 .. 128 ] characters ^[a-z]+$ system name Example: 7nj

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: v

Request Body schema: application/json
required

	object error from the tag operation
tags	Array of strings tags defining the module

Responses

201

Created response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

post/iacm/api/modules/{name}/{system}/tags

Request samples

Payload
curl
Java
Go

application/json

{"error": {"Ut at et autem.": "Aspernatur quia qui sit eveniet rerum expedita."
},
"tags": ["Culpa et iusto aut.",
"Error pariatur aliquid laborum corporis maiores."
]
}

list-connectors module-registry

List all connectors from the module registry for a specific account

Securityx-api-key

Request

header Parameters

Harness-Account

required

string

account name

Example: Repellendus maiores.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules/connectors

Request samples

curl
Java
Go

Response samples

application/json

["Esse eveniet enim nulla omnis explicabo voluptas.",
"Corporis quia temporibus.",
"Beatae earum totam architecto sunt magnam.",
"Qui cupiditate."
]

download module-registry

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Aut dolor porro animi culpa sint id.
name required	string module name Example: Odio consequuntur incidunt vel maiores.
system required	string system name Example: Ipsam corporis quo consequatur et.
version required	string version of the module Example: Occaecati veniam.

Responses

204

No Content response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/registry/account/{account}/{name}/{system}/{version}/download

Request samples

curl
Java
Go

list-versions module-registry

list-module-versions returns an array of versions for a given module

Securityx-api-key

Request

path Parameters

account required	string account name Example: Assumenda voluptas repudiandae.
name required	string module name Example: Assumenda mollitia.
system required	string system name Example: Quisquam ipsum exercitationem voluptatem deserunt minima.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/registry/account/{account}/{name}/{system}/versions

Request samples

curl
Java
Go

Response samples

application/json

{"modules": [{"versions": [{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
},
{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
}
]
},
{"versions": [{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
},
{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
}
]
},
{"versions": [{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
},
{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
}
]
},
{"versions": [{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
},
{"git_version": "Vel consectetur sunt facilis ipsam.",
"module_version": "Velit placeat porro quaerat hic beatae ullam."
}
]
}
]
}

➔ Next to workspaces

module-registry

list_modules-by-account module-registry

query Parameters

header Parameters

create-module module-registry

header Parameters

Request Body schema: application/jsonrequired

delete-module module-registry

path Parameters

header Parameters

list-modules-by-id module-registry

path Parameters

header Parameters

update-module module-registry

path Parameters

header Parameters

Request Body schema: application/jsonrequired

sync-module-metadata module-registry

path Parameters

header Parameters

list-metadata-by-module module-registry

path Parameters

query Parameters

header Parameters

list-readme-by-id module-registry

path Parameters

query Parameters

header Parameters

module-parsed-data module-registry

path Parameters

header Parameters

Request Body schema: application/jsonrequired

post-module-readme module-registry

path Parameters

query Parameters

header Parameters

post-module-tags module-registry

path Parameters

header Parameters

Request Body schema: application/jsonrequired

list-connectors module-registry

header Parameters

download module-registry

path Parameters

list-versions module-registry

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required