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,ASC

header Parameters

Harness-Account

required

string

account name

Example: Maxime tempora qui quas 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": "g98",
"created": 4586157054658717700,
"description": "Voluptas eum.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "ay",
"repository": "Possimus voluptatem quidem dolorem ullam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Autem ipsum tempora sed et.",
"repository_path": "",
"synced": 8506218261545045000,
"system": "e3",
"tags": "Distinctio suscipit et et aut saepe.",
"updated": 4915269518487898000,
"versions": ["Tempora magnam eligendi neque odio qui.",
"Et qui ratione nostrum quis reprehenderit expedita."
]
},
{"account": "g98",
"created": 4586157054658717700,
"description": "Voluptas eum.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "ay",
"repository": "Possimus voluptatem quidem dolorem ullam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Autem ipsum tempora sed et.",
"repository_path": "",
"synced": 8506218261545045000,
"system": "e3",
"tags": "Distinctio suscipit et et aut saepe.",
"updated": 4915269518487898000,
"versions": ["Tempora magnam eligendi neque odio qui.",
"Et qui ratione nostrum quis reprehenderit expedita."
]
},
{"account": "g98",
"created": 4586157054658717700,
"description": "Voluptas eum.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "ay",
"repository": "Possimus voluptatem quidem dolorem ullam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Autem ipsum tempora sed et.",
"repository_path": "",
"synced": 8506218261545045000,
"system": "e3",
"tags": "Distinctio suscipit et et aut saepe.",
"updated": 4915269518487898000,
"versions": ["Tempora magnam eligendi neque odio qui.",
"Et qui ratione nostrum quis reprehenderit expedita."
]
}
]

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: 74

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 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": "Mollitia neque.",
"name": "v",
"repository": "Dolores nulla eos provident accusamus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Iusto accusantium doloribus temporibus.",
"repository_path": "",
"system": "7",
"tags": "Voluptatem corporis eius."
}

Response samples

application/json

{"account": "2",
"created": 3645276126315231000,
"description": "Corporis sunt quisquam aliquam ullam.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "qv1",
"repository": "Explicabo vel nihil incidunt aliquid blanditiis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Reiciendis velit assumenda.",
"repository_path": "",
"system": "fg",
"tags": "Vel veritatis quas praesentium quos laudantium et.",
"updated": 4034022842249195500
}

delete-module module-registry

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Nam ipsa adipisci neque magni.

header Parameters

Harness-Account

required

string

account name

Example: Autem consequatur odio reprehenderit quia.

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: Ratione qui ut adipisci deleniti dolorum similique.

header Parameters

Harness-Account

required

string

account name

Example: Rerum accusantium voluptatum.

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": "p",
"created": 1358090194047994000,
"description": "Error inventore saepe animi voluptatem.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "qr4",
"repository": "Laboriosam labore illo magnam quae officia.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Ducimus sed sed enim.",
"repository_path": "",
"synced": 6010789834196637000,
"system": "8h",
"tags": "Et enim dolores earum tempore totam porro.",
"updated": 7179255640916961000,
"versions": ["Molestiae consequatur nihil quibusdam commodi non itaque.",
"Dolorem perferendis et dolore eum et.",
"Rerum et."
]
}

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: ve

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 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": "Natus eum recusandae fugit officiis delectus omnis.",
"name": "kg",
"repository": "Facere perferendis ab sunt.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut temporibus et aperiam dignissimos tenetur.",
"repository_path": "",
"system": "c",
"tags": "Voluptate hic quae omnis et maxime sunt."
}

sync-module-metadata module-registry

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Modi sit necessitatibus saepe.

header Parameters

Harness-Account

required

string

account name

Example: Quia 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: Corrupti beatae exercitationem recusandae aspernatur fuga.

query Parameters

version required	string version of the module Example: version=Quas est rerum aspernatur.
submodule	string submodule name Example: submodule=Sed quae repellat sequi nulla architecto eum.

header Parameters

Harness-Account

required

string

account name

Example: Quos veniam.

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": "Autem iure iusto.",
"module_version": "Voluptas placeat nisi quisquam reprehenderit est.",
"name": "Enim provident.",
"outputs": [{"output_description": "Nesciunt facilis dignissimos.",
"output_name": "Vitae laudantium qui.",
"output_sensitive": true
},
{"output_description": "Nesciunt facilis dignissimos.",
"output_name": "Vitae laudantium qui.",
"output_sensitive": true
},
{"output_description": "Nesciunt facilis dignissimos.",
"output_name": "Vitae laudantium qui.",
"output_sensitive": true
},
{"output_description": "Nesciunt facilis dignissimos.",
"output_name": "Vitae laudantium qui.",
"output_sensitive": true
}
],
"providers": [{"provider_name": "Explicabo a quibusdam et.",
"provider_source": "Repellat sunt soluta.",
"provider_version": "Repellat in cum quae optio qui."
},
{"provider_name": "Explicabo a quibusdam et.",
"provider_source": "Repellat sunt soluta.",
"provider_version": "Repellat in cum quae optio qui."
}
],
"resources": [{"resource_name": "Vitae id molestias qui odio.",
"resource_type": "Ab suscipit fugit numquam asperiores itaque."
},
{"resource_name": "Vitae id molestias qui odio.",
"resource_type": "Ab suscipit fugit numquam asperiores itaque."
}
],
"submodule": ["Voluptas libero error eveniet.",
"Ea quis est voluptate et."
],
"system": "Aut voluptatem maiores porro facere quod natus.",
"variables": [{"variable_default": "Magni labore eum reiciendis et esse debitis.",
"variable_description": "Assumenda nihil quos.",
"variable_name": "Placeat et dignissimos fugiat.",
"variable_required": true,
"variable_sensitive": false,
"variable_type": "Nisi ea quo."
},
{"variable_default": "Magni labore eum reiciendis et esse debitis.",
"variable_description": "Assumenda nihil quos.",
"variable_name": "Placeat et dignissimos fugiat.",
"variable_required": true,
"variable_sensitive": false,
"variable_type": "Nisi ea quo."
}
]
}

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: Voluptatem fugiat assumenda.

query Parameters

version required	string version of the module Example: version=Id sed placeat est rerum laboriosam.
submodule	string submodule name Example: submodule=Occaecati facere vel ut.

header Parameters

Harness-Account

required

string

account name

Example: Pariatur ut aperiam fugiat qui architecto.

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: Pariatur itaque sed ut.
system required	string system name Example: Id eum ab voluptatem officiis omnis.
version required	string version of the module Example: Corrupti aut distinctio sequi suscipit.

header Parameters

Harness-Account

required

string

account name

Example: Velit non fuga explicabo.

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": "Ut voluptas nihil in est.",
"error": {"Ad cupiditate tempore voluptas occaecati ut assumenda.": "Minima magnam repellat error."
},
"git_tag": "Ullam et tempore autem.",
"metadata": "Sequi enim tempore et.",
"repo_url": "Fuga earum et qui exercitationem accusantium porro.",
"submodule_name": "Et voluptatem qui sit.",
"submodule_paths": ["Ab qui qui sint.",
"Sit voluptate fuga aut."
]
}

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: Aut et autem.
system required	string system name Example: Fuga est sapiente neque odit commodi.
version required	string version of the module Example: Labore et cupiditate labore atque necessitatibus.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Ad enim molestias et neque nostrum et.

header Parameters

Harness-Account

required

string

account name

Example: Maxime aut nesciunt.

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: y
system required	string [ 1 .. 128 ] characters system name Example: a6

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: b6z

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": {"Iure dolorem est blanditiis et cum enim.": "Nihil non autem quia aut fugit eos.",
"Occaecati laborum vel placeat odio ipsum.": "Corrupti veritatis vero qui id.",
"Qui est quas aut quibusdam sapiente sapiente.": "Excepturi maiores temporibus id vel consequatur aut."
},
"tags": ["Ullam dolores corporis quia non.",
"Rem recusandae dignissimos et facere qui ipsum."
]
}

download module-registry

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Qui velit.
name required	string module name Example: Velit hic sit optio omnis.
system required	string system name Example: Minima qui libero excepturi non tempore.
version required	string version of the module Example: Delectus aut quam et in.

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: Pariatur non veritatis assumenda et.
name required	string module name Example: Omnis sed maiores voluptatum.
system required	string system name Example: Pariatur occaecati aut quaerat explicabo architecto.

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": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
}
]
},
{"versions": [{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
}
]
},
{"versions": [{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
},
{"git_version": "Consequatur totam rerum eos earum distinctio itaque.",
"module_version": "Amet dolorem ut."
}
]
}
]
}

➔ 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

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