Harness

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

account name

Example: Mollitia dicta omnis esse similique eveniet 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
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:  3rp
Request Body schema: application/json
required
description
string
description of the module


 
name
required
string  [ 1 .. 128 ] characters 
module name


 
org
string  [ 1 .. 1024 ] characters 
org that owns the module


 
project
string  [ 1 .. 1024 ] characters 
project that owns 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.


 
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": "Aut eum quasi et.",
  • "name": "3t",
  • "org": "tfp",
  • "project": "izr",
  • "repository": "Nihil eaque voluptas aut aut.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Voluptatem tempora.",
  • "repository_path": "",
  • "system": "9",
  • "tags": "Autem iste odio possimus."
}
Response samples 
application/json
{
  • "account": "74",
  • "created": 5521634505059528000,
  • "description": "Voluptates beatae maiores quibusdam ad eos.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "5yl",
  • "repository": "Placeat voluptatum dicta voluptatem.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Eaque ut totam adipisci.",
  • "repository_path": "",
  • "system": "m2i",
  • "tags": "Voluptatem praesentium asperiores.",
  • "updated": 1019448564751494100
}
Delete module
Delete a module from the module registry


Securityx-api-key 
Request 
path Parameters
id
required
string
id


 
 Example:  Vel qui autem rerum.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Sit rerum earum.
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:  Iure dicta deleniti nam.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Non et quia ut sit ad earum.
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": "o",
  • "created": 7475249384391209000,
  • "description": "Magnam quia quae blanditiis.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "module_error": "Laborum quisquam.",
  • "name": "t",
  • "org": "mo",
  • "project": "22",
  • "repository": "Cum totam id laborum velit ratione.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Repellat molestias.",
  • "repository_path": "",
  • "repository_url": "Et culpa a ut sunt.",
  • "synced": 2478261726413688000,
  • "system": "p",
  • "tags": "Quibusdam dolores nam.",
  • "testing_enabled": false,
  • "testing_metadata": {
    },
  • "updated": 3914585921572152000,
  • "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:  y
Request Body schema: application/json
required
description
string
description of the module


 
name
required
string  [ 1 .. 128 ] characters 
module name


 
org
string  [ 1 .. 1024 ] characters 
org that owns the module


 
project
string  [ 1 .. 1024 ] characters 
project that owns 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.


 
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": "Sit officia.",
  • "name": "ev",
  • "org": "jh",
  • "project": "vd",
  • "repository": "Ex officiis maiores dolore.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Pariatur sapiente voluptate aliquid quod qui iusto.",
  • "repository_path": "",
  • "system": "u",
  • "tags": "Nihil quasi cupiditate ducimus at et non."
}
Create testing pipeline
Create a new testing pipeline for a given module


Securityx-api-key 
Request 
path Parameters
id
required
string
module id


 
 Example:  Soluta dolores reprehenderit voluptas.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  8
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": "j",
  • "project": "p"
}
Sync module metadata
Sync the module metadata from the module registry


Securityx-api-key 
Request 
path Parameters
id
required
string
id


 
 Example:  Adipisci voluptas at eveniet.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Voluptatem eum possimus soluta reprehenderit aliquam.
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:  5547227243125020000
header Parameters
Harness-Account
required
string
account name


 
 Example:  Ullam id veritatis provident placeat.
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:  Delectus quisquam doloremque et in ea enim.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  9m4
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": "pya",
  • "pipeline_id": [
    ],
  • "project": "py",
  • "provider_connector": "Ex esse.",
  • "provisioner_type": "Illo sit ipsam autem praesentium omnis perferendis.",
  • "provisioner_version": "Vitae ut facilis quisquam consectetur blanditiis.",
  • "release_pipeline": "Commodi cupiditate eum fugiat."
}
Update module testing
Update module testing metadata


Securityx-api-key 
Request 
path Parameters
id
required
string
module id


 
 Example:  Dolorem tempora voluptatum.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  7bu
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": "z",
  • "pipeline_id": [
    ],
  • "project": "ks9",
  • "provider_connector": "Voluptatum libero consequatur et ex.",
  • "provisioner_type": "Necessitatibus ut dolores laudantium ut.",
  • "provisioner_version": "Qui non atque dolor.",
  • "release_pipeline": "Aliquid ut et."
}
List module metadata
List the module metadata from the module registry


Securityx-api-key 
Request 
path Parameters
module_id
required
string
module id


 
 Example:  Quia eos consectetur praesentium ducimus id.
query Parameters
version
required
string
version of the module


 
 Example:  version=Ipsum qui.
submodule
string
submodule name


 
 Example:  submodule=Libero in consequatur nihil quia provident.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Quae quos sapiente numquam.
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": "Perferendis asperiores architecto a quidem debitis.",
  • "dependencies": [
    ],
  • "metadata_error": "Sit et temporibus autem voluptatibus eveniet.",
  • "module_version": "Quasi dolores iure fuga.",
  • "name": "Consequatur et ipsa reprehenderit dolorem sit.",
  • "outputs": [
    ],
  • "providers": [
    ],
  • "resources": [
    ],
  • "submodule": [
    ],
  • "system": "Voluptatum aut doloribus.",
  • "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:  Vitae animi.
query Parameters
version
required
string
version of the module


 
 Example:  version=Culpa vero.
submodule
string
submodule name


 
 Example:  submodule=Dolorem quisquam quae.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Repudiandae quaerat debitis et hic quasi recusandae.
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:  5
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": "2ir",
  • "eventType": "Voluptate itaque iusto et eum.",
  • "metadata": {
    },
  • "org": "zdf",
  • "project": "59p"
}
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:  Voluptas explicabo facilis est soluta.
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=Modi ut qui velit exercitationem.
status
Array of strings
Status of the execution


 
 Example:  status=At et quasi dolore optio.&status=Voluptas maxime in consequatur.&status=Tempora perspiciatis molestiae eum recusandae fuga.
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:  33s
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:  Libero aliquam quod.
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": "lw1",
  • "org": "5g",
  • "pipeline": "Repellat accusantium nesciunt autem ipsum eos commodi.",
  • "pipelineExecutionId": "Dolores consequuntur ad fugit.",
  • "pipelineStageId": "Suscipit consequuntur officiis.",
  • "project": "xtc"
}
Response samples 
application/json
{
  • "account": "xo3",
  • "created": 2598221031065834500,
  • "metadata": {
    },
  • "moduleId": "Voluptas ipsum.",
  • "org": "l",
  • "project": "l",
  • "status": "Reiciendis consequatur ipsa voluptas eligendi quasi quia."
}
Create module data
Create a new module in the module registry


Securityx-api-key 
Request 
path Parameters
name
required
string
module name


 
 Example:  Dolorem accusantium quia.
system
required
string
system name


 
 Example:  Quo repudiandae pariatur sapiente quia explicabo.
version
required
string
version of the module


 
 Example:  Repellat et quae est accusantium et.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Molestiae autem voluptatem minus sed vel est.
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": "Tenetur ipsa ut vitae eveniet quia possimus.",
  • "error": {
    },
  • "examples_paths": [
    ],
  • "git_tag": "Omnis sed in qui amet consequatur.",
  • "metadata": "Odio ea reprehenderit recusandae magni et sapiente.",
  • "repo_url": "Architecto ullam consequatur repellat ut qui.",
  • "submodule_name": "Provident quis fugit fugiat perspiciatis optio nemo.",
  • "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:  Et quidem alias.
system
required
string
system name


 
 Example:  Aut fuga repellat rerum omnis dolorem.
version
required
string
version of the module


 
 Example:  Est fuga inventore eum natus.
query Parameters
submoduleName
string
submodule name


 
 Example:  submoduleName=Nihil culpa minima ab pariatur.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Error ipsum tenetur corrupti impedit voluptatibus ut.
Content-Length
integer <int64> 
Size in bytes of the readme


 
 Example:  5204999107930717000
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:  add
system
required
string  [ 1 .. 128 ] characters ^[a-z]+$
system name


 
 Example:  lbw
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
account that owns the module


 
 Example:  7k
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:  Voluptas sequi ullam facilis soluta vel soluta.
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
[
  • "Eligendi dolor laborum.",
  • "Minima error maiores commodi odio et est.",
  • "Maxime unde eius vel.",
  • "Deserunt et eum iusto placeat officia."
]
Download module
Download a module given a specific version


Securityx-api-key 
Request 
path Parameters
account
required
string
account name


 
 Example:  Officiis inventore debitis eius sit aliquid officiis.
name
required
string
module name


 
 Example:  Qui libero voluptatibus explicabo qui perspiciatis.
system
required
string
system name


 
 Example:  Ipsa odit temporibus aliquid.
version
required
string
version of the module


 
 Example:  Dignissimos praesentium facilis voluptatem quo aut.
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:  Qui et et laudantium mollitia consequatur voluptatibus.
name
required
string
module name


 
 Example:  Quidem et et et saepe ab.
system
required
string
system name


 
 Example:  Cupiditate nobis.
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": [
    ]
}
➔ Next to workspaces