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: Dolorum velit et porro.
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
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

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: gz2
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
application/json
{
  • "description": "Qui exercitationem.",
  • "name": "ynl",
  • "repository": "Omnis deserunt error nobis in corrupti.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Odio ea dolores perferendis eos esse ut.",
  • "repository_path": "",
  • "system": "d3i",
  • "tags": "Porro animi provident non voluptatem."
}
Response samples
application/json
{
  • "account": "v3f",
  • "created": 5739459064460274000,
  • "description": "At vitae reprehenderit dolorem voluptates.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "jf0",
  • "repository": "Atque omnis ut voluptatem qui commodi eos.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Debitis reiciendis et consectetur distinctio sequi.",
  • "repository_path": "",
  • "system": "g",
  • "tags": "Repudiandae maiores magnam tenetur.",
  • "updated": 5894196938152685000
}

delete-module module-registry

Delete a module from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Et recusandae placeat excepturi aut sed.
header Parameters
Harness-Account
required
string

account name

Example: Tenetur quia perferendis.
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

list-modules-by-id module-registry

List a module from the module registry by ID

Securityx-api-key
Request
path Parameters
id
required
string

module id

Example: At quia harum exercitationem non.
header Parameters
Harness-Account
required
string

account name

Example: Ut et id optio voluptatem quasi.
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
Response samples
application/json
{
  • "account": "8s",
  • "created": 7637719728700101000,
  • "description": "Reiciendis officiis ut ut id.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "du",
  • "repository": "Reiciendis error.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Velit unde.",
  • "repository_path": "",
  • "repository_url": "Voluptatem consequatur occaecati sapiente est.",
  • "synced": 8475593724732583000,
  • "system": "xa",
  • "tags": "Voluptatem doloremque quia.",
  • "updated": 744651359050326800,
  • "versions": [
    ]
}

update-module module-registry

Update a module in the module registry

Securityx-api-key
Request
path Parameters
id
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: mlf
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
application/json
{
  • "description": "Earum quia libero corporis.",
  • "name": "oli",
  • "repository": "Ut eveniet dolor.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Quis quae non facere fuga.",
  • "repository_path": "",
  • "system": "t",
  • "tags": "Non autem suscipit beatae quibusdam soluta."
}

sync-module-metadata module-registry

Sync the module metadata from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Cum ut dolorem iure.
header Parameters
Harness-Account
required
string

account name

Example: Earum fugiat recusandae voluptatibus blanditiis quia illo.
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

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: Nobis totam consequatur repellat commodi qui.
query Parameters
version
required
string

version of the module

Example: version=Autem numquam incidunt nesciunt quas.
submodule
string

submodule name

Example: submodule=Labore dolor quo voluptas laboriosam asperiores.
header Parameters
Harness-Account
required
string

account name

Example: Et accusamus possimus et.
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
Response samples
application/json
{
  • "account": "Libero dolores eum voluptas porro.",
  • "dependencies": [
    ],
  • "module_version": "Placeat quidem quis ut.",
  • "name": "Ab velit natus nobis ullam officiis.",
  • "outputs": [
    ],
  • "providers": [
    ],
  • "resources": [
    ],
  • "submodule": [
    ],
  • "system": "Nesciunt est non sunt.",
  • "variables": [
    ]
}

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: Fugit et expedita ex.
query Parameters
version
required
string

version of the module

Example: version=Et quia tempore vero aliquam.
submodule
string

submodule name

Example: submodule=Doloribus accusamus aut distinctio id.
header Parameters
Harness-Account
required
string

account name

Example: Cupiditate accusantium sed.
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
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: Perferendis accusamus animi maxime et quo ducimus.
system
required
string

system name

Example: Fugiat quis error quam corporis a assumenda.
version
required
string

version of the module

Example: Ut distinctio veritatis sunt laudantium.
header Parameters
Harness-Account
required
string

account name

Example: Excepturi exercitationem ab nobis.
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
application/json
{
  • "download_url": "Illum beatae molestiae.",
  • "error": {
    },
  • "git_tag": "Delectus reiciendis vel facere ratione alias qui.",
  • "metadata": "Dicta praesentium occaecati.",
  • "repo_url": "Esse porro est et.",
  • "submodule_name": "Cupiditate eaque cupiditate amet.",
  • "submodule_paths": [
    ]
}

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: Maxime nemo nostrum vel et consequatur.
system
required
string

system name

Example: Earum alias molestiae ratione eius.
version
required
string

version of the module

Example: Nulla maiores vel.
query Parameters
submoduleName
string

submodule name

Example: submoduleName=Quia sunt dolorem.
header Parameters
Harness-Account
required
string

account name

Example: Libero consequuntur.
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

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: ifv
system
required
string [ 1 .. 128 ] characters

system name

Example: 6n
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

account that owns the module

Example: 3v
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
application/json
{
  • "error": {
    },
  • "tags": [
    ]
}

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: At asperiores temporibus debitis ipsa dolorem delectus.
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
Response samples
application/json
[
  • "Ad iure.",
  • "Recusandae iure ut odit soluta."
]

download module-registry

Download a module given a specific version

Securityx-api-key
Request
path Parameters
account
required
string

account name

Example: Explicabo aut est neque cumque.
name
required
string

module name

Example: Natus a error.
system
required
string

system name

Example: Voluptatem quis quae ut atque et.
version
required
string

version of the module

Example: Animi 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

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: Aut sint vero enim ratione.
name
required
string

module name

Example: Voluptatibus assumenda.
system
required
string

system name

Example: Minima rerum possimus sed illum illum.
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
Response samples
application/json
{
  • "modules": [
    ]
}