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=name,ASC
header Parameters
Harness-Account
required
string

account name

Example: Quo cum rerum iste.
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/modules/v1
Request samples
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

service-discovery module-registry

service-discovery returns the list of services that are available in the module-registry

Securityx-api-key
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/modules/v1/.well-known/terraform.json
Request samples
Response samples
application/json
{
  • "modules.v1": "Totam officia."
}

download module-registry

Download a module given a specific version

Securityx-api-key
Request
path Parameters
account
required
string

account name

Example: Dolorem et adipisci.
name
required
string

module name

Example: Neque dicta quasi quia omnis nobis tempore.
system
required
string

system name

Example: Vitae perferendis incidunt aut assumenda et.
version
required
string

version of the module

Example: Quisquam enim rem similique.
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/modules/v1/{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: Ut animi.
name
required
string

module name

Example: Et consequatur aliquam.
system
required
string

system name

Example: Officia assumenda labore.
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/modules/v1/{account}/{name}/{system}/versions
Request samples
Response samples
application/json
{
  • "modules": [
    ]
}

delete-module module-registry

Delete a module from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Sunt error nisi.
header Parameters
Harness-Account
required
string

account name

Example: Sed est.
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/modules/v1/{id}
Request samples

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: 5ky
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/modules/v1/{id}
Request samples
application/json
{
  • "description": "Deleniti quisquam facilis iure debitis exercitationem autem.",
  • "name": "1",
  • "repository": "Ea dolore qui et sit facilis atque.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Beatae nam cumque enim sunt.",
  • "repository_path": "",
  • "system": "npz",
  • "tags": "Quam rerum saepe totam ullam aliquam."
}

sync-module-metadata module-registry

Sync the module metadata from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Ex adipisci eos et.
header Parameters
Harness-Account
required
string

account name

Example: Ipsa laboriosam impedit eum sint eos delectus.
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/modules/v1/{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: Non incidunt fuga ipsum iure sed.
query Parameters
version
required
string

version of the module

Example: version=Non reiciendis sit deserunt.
submodule
string

submodule name

Example: submodule=Expedita eaque accusantium ea quo quae.
header Parameters
Harness-Account
required
string

account name

Example: Magnam sed et et quam deleniti.
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/modules/v1/{module_id}/metadata
Request samples
Response samples
application/json
{
  • "account": "Quis reprehenderit expedita atque aut.",
  • "module_version": "Et quibusdam rerum et.",
  • "name": "Nihil debitis molestiae consequatur nihil quibusdam commodi.",
  • "outputs": [
    ],
  • "providers": [
    ],
  • "resources": [
    ],
  • "submodule": [
    ],
  • "system": "Itaque et dolorem perferendis et dolore.",
  • "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: Voluptatum et et necessitatibus ut rerum deserunt.
query Parameters
version
required
string

version of the module

Example: version=Sapiente neque illum quod error consequatur.
submodule
string

submodule name

Example: submodule=Laboriosam omnis voluptatem itaque.
header Parameters
Harness-Account
required
string

account name

Example: Dolores neque.
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/modules/v1/{module_id}/readme
Request samples
Response samples
application/json
"string"

create-module module-registry

Create a new module in the module registry

Securityx-api-key
Request
path Parameters
name
required
string [ 1 .. 128 ] characters

module name

Example: bex
system
required
string [ 1 .. 128 ] characters

system name

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

account that owns the module

Example: 89m
Request Body schema: application/json
required
description
string

description of the module

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.

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/modules/v1/{name}/{system}
Request samples
application/json
{
  • "description": "Aut aut provident.",
  • "repository": "Explicabo explicabo quaerat natus dolores.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Aut aut eveniet est aliquam alias sint.",
  • "repository_path": "",
  • "tags": "Cum occaecati totam totam sed vel adipisci."
}
Response samples
application/json
{
  • "account": "f1e",
  • "created": 706594139652027400,
  • "description": "Quo magni maxime aliquam excepturi quasi.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "7",
  • "repository": "Reprehenderit labore fuga voluptatibus.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Asperiores quo.",
  • "repository_path": "",
  • "system": "r6t",
  • "tags": "Itaque quaerat voluptatum.",
  • "updated": 4919416249932504000
}

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: Reprehenderit voluptatibus optio est sed inventore voluptatem.
system
required
string

system name

Example: Itaque ut vel pariatur tenetur.
version
required
string

version of the module

Example: Accusantium possimus non.
header Parameters
Harness-Account
required
string

account name

Example: Quos placeat odit cum et.
Request Body schema: application/json
required
download_url
required
string

download url of the module

git_tag
required
string

git tag of the module

metadata
required
string

metadata to be parsed

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/modules/v1/{name}/{system}/{version}/metadata
Request samples