module-registry

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

List modules

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: Recusandae quia.
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

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: 04h
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
application/json
{
  • "description": "Minima corporis enim omnis id beatae.",
  • "name": "ub",
  • "repository": "Libero reprehenderit reiciendis repellendus sapiente.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Nostrum nobis in consectetur ut aut.",
  • "repository_path": "",
  • "system": "ah",
  • "tags": "Totam tempore enim."
}
Response samples
application/json
{
  • "account": "3",
  • "created": 7172124127998343000,
  • "description": "Consectetur reiciendis consequatur.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "7h8",
  • "repository": "Quae eligendi quasi in quis exercitationem dolores.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Sequi quia similique.",
  • "repository_path": "",
  • "system": "s47",
  • "tags": "Consequatur laudantium cum aperiam corrupti.",
  • "updated": 4143813240737887000
}

Delete module

Delete a module from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Dolores praesentium voluptas omnis ipsum.
header Parameters
Harness-Account
required
string

account name

Example: Odio corporis aut enim commodi.
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 module by id

List a module from the module registry by ID

Securityx-api-key
Request
path Parameters
id
required
string

module id

Example: Qui ducimus quos non aliquam.
header Parameters
Harness-Account
required
string

account name

Example: Ipsa sit unde qui commodi.
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": "kr",
  • "created": 8057765349902451000,
  • "description": "Omnis ab quos.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "module_error": "Corporis cumque harum impedit quis.",
  • "name": "3g",
  • "repository": "Voluptatem voluptatem sint.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Aut incidunt quidem autem aspernatur a culpa.",
  • "repository_path": "",
  • "repository_url": "Eveniet qui veniam.",
  • "synced": 5661337002475365000,
  • "system": "h",
  • "tags": "Eum itaque vel et tenetur.",
  • "testing_enabled": true,
  • "testing_metadata": {
    },
  • "updated": 5917620634086350000,
  • "versions": [
    ]
}

Update module

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: fen
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
application/json
{
  • "description": "Distinctio eum nihil eos.",
  • "name": "hc",
  • "repository": "Optio et mollitia.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Accusamus quasi ut aut.",
  • "repository_path": "",
  • "system": "6cx",
  • "tags": "Ratione ipsum."
}

Create testing pipeline

Create a new testing pipeline for a given module

Securityx-api-key
Request
path Parameters
id
required
string

module id

Example: Qui illum dolores eius sunt.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 0y
Request Body schema: application/json
required
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

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/{id}/pipeline
Request samples
application/json
{
  • "org": "1",
  • "project": "n"
}

Sync module metadata

Sync the module metadata from the module registry

Securityx-api-key
Request
path Parameters
id
required
string

id

Example: Sunt quia porro adipisci qui quis.
header Parameters
Harness-Account
required
string

account name

Example: Exercitationem occaecati expedita aut veritatis sit.
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

Disable testing

Disable testing for a module

Securityx-api-key
Request
path Parameters
id
required
integer <int64>

module id

Example: 2957587365608723000
header Parameters
Harness-Account
required
string

account name

Example: Laudantium ut dicta earum enim accusamus.
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}/testing
Request samples

Enable testing

Enable testing for a module

Securityx-api-key
Request
path Parameters
id
required
string

module id

Example: Qui qui libero est.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: oga
Request Body schema: application/json
required
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

pipeline_id
Array of strings

pipelines to create the webhooks to trigger the executions for testing

project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

provider_connector
required
string

provider connector

provisioner_type
required
string

provisioner type

provisioner_version
required
string

provisioner version

release_pipeline
string

pipeline to create the webhooks for releases

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}/testing
Request samples
application/json
{
  • "org": "7",
  • "pipeline_id": [
    ],
  • "project": "p",
  • "provider_connector": "Et ad enim error laborum.",
  • "provisioner_type": "Saepe ipsum quasi earum est.",
  • "provisioner_version": "Laudantium aliquam.",
  • "release_pipeline": "Libero dolor voluptatibus ipsa ipsam."
}

Update module testing

Update module testing metadata

Securityx-api-key
Request
path Parameters
id
required
string

module id

Example: Error vero magni amet.
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: nq
Request Body schema: application/json
required
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

pipeline_id
Array of strings

pipelines to create the webhooks to trigger the executions for testing

project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

provider_connector
required
string

provider connector

provisioner_type
required
string

provisioner type

provisioner_version
required
string

provisioner version

release_pipeline
string

pipeline to create the webhooks for releases

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}/testing
Request samples
application/json
{
  • "org": "k",
  • "pipeline_id": [
    ],
  • "project": "vp",
  • "provider_connector": "Ipsam autem.",
  • "provisioner_type": "Omnis perferendis.",
  • "provisioner_version": "Vitae ut facilis quisquam consectetur blanditiis.",
  • "release_pipeline": "Commodi cupiditate eum fugiat."
}

List module metadata

List the module metadata from the module registry

Securityx-api-key
Request
path Parameters
module_id
required
string

module id

Example: Quae occaecati.
query Parameters
version
required
string

version of the module

Example: version=Impedit quis qui non.
submodule
string

submodule name

Example: submodule=Quia nulla autem expedita facilis rem error.
header Parameters
Harness-Account
required
string

account name

Example: Aperiam incidunt similique corporis 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": "Et eum.",
  • "dependencies": [
    ],
  • "metadata_error": "Ex officiis maiores dolore.",
  • "module_version": "Cupiditate enim quia provident esse.",
  • "name": "Veniam cum doloremque modi est cupiditate atque.",
  • "outputs": [
    ],
  • "providers": [
    ],
  • "resources": [
    ],
  • "submodule": [
    ],
  • "system": "Nam consequatur sed.",
  • "variables": [
    ]
}

List module readme

List the module readme from the module registry

Securityx-api-key
Request
path Parameters
module_id
required
string

module id

Example: Fugit nulla consequatur beatae quas.
query Parameters
version
required
string

version of the module

Example: version=Omnis ut ullam quis.
submodule
string

submodule name

Example: submodule=Voluptates corporis.
header Parameters
Harness-Account
required
string

account name

Example: Voluptas et dolores tenetur 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"

Send an event related with a module execution

Send an event related with a module execution

Securityx-api-key
Request
path Parameters
moduleId
required
string [ 1 .. 1024 ] characters

module id associated with this event

Example: qfb
Request Body schema: application/json
required
account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

eventType
required
string

The type of event that occurred

object (ModuleExecutionMetadata)
org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

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/{moduleId}/events
Request samples
application/json
{
  • "account": "r",
  • "eventType": "Corporis nobis temporibus et sint fugiat ad.",
  • "metadata": {
    },
  • "org": "j",
  • "project": "qii"
}

List executions for a specific module

List all module executions for a module.

Securityx-api-key
Request
path Parameters
moduleId
required
string

Module identifier

Example: Enim ipsa dolores eum aliquid dolor.
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
pipeline_execution_id
string

Pipeline identifier

Example: pipeline_execution_id=Facilis nam.
status
Array of strings

Status of the execution

Example: status=Maxime omnis aperiam dolor tempore rem vitae.&status=Fugit blanditiis ea dolore consequatur.&status=Similique sit sunt consectetur.&status=Cumque ratione.
start_time
integer <int64>

Specify the start time for the query

Example: start_time=1691150743950
end_time
integer <int64>

Specify the end time limit for the query

Example: end_time=1691150743950
header Parameters
Harness-Account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: k12
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/{moduleId}/executions
Request samples
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create a new module execution

Create a new module execution.

Securityx-api-key
Request
path Parameters
moduleId
required
string

The unique identifier for the associated module

Example: Laboriosam est et illum iure.
Request Body schema: application/json
required
account
required
string [ 1 .. 128 ] characters

Account is the internal customer account ID.

org
required
string [ 1 .. 128 ] characters

Org is the organisation identifier.

pipeline
required
string

The unique identifier for the associated pipeline

pipelineExecutionId
required
string

The unique identifier for the associated pipeline execution

pipelineStageId
required
string

The unique identifier for the associated pipeline stage

project
required
string [ 1 .. 128 ] characters

Project is the project identifier.

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/{moduleId}/executions
Request samples
application/json
{
  • "account": "l39",
  • "org": "qaj",
  • "pipeline": "Sunt est corrupti et nihil.",
  • "pipelineExecutionId": "Beatae sapiente omnis ullam dolorem ut.",
  • "pipelineStageId": "Sunt accusamus aut inventore.",
  • "project": "xgy"
}
Response samples
application/json
{
  • "account": "0bx",
  • "created": 5082474534737203000,
  • "metadata": {
    },
  • "moduleId": "Nisi totam atque hic enim.",
  • "org": "in",
  • "project": "b",
  • "status": "Consequatur quidem aut aliquid expedita quo."
}

Create module data

Create a new module in the module registry

Securityx-api-key
Request
path Parameters
name
required
string

module name

Example: Reiciendis et aspernatur odit minima.
system
required
string

system name

Example: Voluptatem delectus.
version
required
string

version of the module

Example: Numquam et est.
header Parameters
Harness-Account
required
string

account name

Example: Earum qui.
Request Body schema: application/json
required
download_url
required
string

download url of the module

object

error from the tag operation

examples_paths
Array of strings

path of the examples relative to the module

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": "Incidunt in doloremque quos.",
  • "error": {
    },
  • "examples_paths": [
    ],
  • "git_tag": "Voluptatem vel.",
  • "metadata": "Beatae amet consequatur ut sit sit necessitatibus.",
  • "repo_url": "Repellendus quia.",
  • "submodule_name": "Natus dignissimos repellat tempora sit id illum.",
  • "submodule_paths": [
    ]
}

Create module readme

Endpoint to push the Readme for a given module

Securityx-api-key
Request
path Parameters
name
required
string

module name

Example: Voluptas sunt.
system
required
string

system name

Example: Alias dignissimos dignissimos qui.
version
required
string

version of the module

Example: Consequatur qui autem incidunt.
query Parameters
submoduleName
string

submodule name

Example: submoduleName=Voluptate id dolor voluptas eius.
header Parameters
Harness-Account
required
string

account name

Example: Quisquam repudiandae vel quidem repudiandae eligendi animi.
Content-Length
integer <int64>

Size in bytes of the readme

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

Create module tags

List all tags for a given module

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

module name

Example: r
system
required
string [ 1 .. 128 ] characters ^[a-z]+$

system name

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

account that owns the module

Example: 4c
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

List all connectors from the module registry for a specific account

Securityx-api-key
Request
header Parameters
Harness-Account
required
string

account name

Example: Eos dolores aut molestiae omnis voluptas.
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
[
  • "Quae accusantium.",
  • "Veritatis rem minus.",
  • "Voluptas repellat repudiandae.",
  • "Tempora voluptas omnis consequatur laboriosam."
]

Download module

Download a module given a specific version

Securityx-api-key
Request
path Parameters
account
required
string

account name

Example: Voluptatem necessitatibus similique omnis veritatis qui.
name
required
string

module name

Example: Id id voluptate expedita est est odio.
system
required
string

system name

Example: Est voluptatem consequatur.
version
required
string

version of the module

Example: Molestiae neque et vel sed.
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 module versions

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

Securityx-api-key
Request
path Parameters
account
required
string

account name

Example: Nihil inventore suscipit sit porro.
name
required
string

module name

Example: Sequi dicta sit.
system
required
string

system name

Example: Ut iste deleniti non.
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": [
    ]
}