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

account name

Example: Odio quo quidem praesentium laudantium.
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:  wo
Request Body schema: application/json
required
description
string
description of the module


 
git_tag_style
string
Git Tag Style


 
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": "Quas nihil nihil aut sequi quod eius.",
  • "git_tag_style": "Autem itaque laborum sed amet modi.",
  • "name": "r8u",
  • "org": "20",
  • "project": "m",
  • "repository": "Est facilis magni sed repellendus aspernatur.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Architecto fugit harum quo quaerat asperiores.",
  • "repository_path": "",
  • "system": "x",
  • "tags": "Similique et voluptatum quia consequuntur."
}
Response samples 
application/json
{
  • "account": "r2e",
  • "created": 5913328886363894000,
  • "description": "Placeat voluptas et.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "name": "1g4",
  • "repository": "Neque dolores voluptates in ut.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Perferendis asperiores architecto a quidem debitis.",
  • "repository_path": "",
  • "system": "0x",
  • "tags": "Ipsa sunt iste est deserunt maiores.",
  • "updated": 4795926265794403000
}
Delete module
Delete a module from the module registry


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


 
 Example:  Eos tenetur architecto.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Officiis omnis autem qui dolores.
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:  Aut nihil nostrum laborum est.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Est dolores aspernatur sit.
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": "8yk",
  • "created": 6967272858745389000,
  • "description": "Mollitia consequatur magnam.",
  • "git_tag_style": "Quam quidem est recusandae necessitatibus dolor sit.",
  • "id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
  • "module_error": "Voluptatibus eaque quis rem et.",
  • "name": "b",
  • "org": "w6k",
  • "project": "rd",
  • "repository": "A excepturi.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Molestiae officiis magni odit sed nihil explicabo.",
  • "repository_path": "",
  • "repository_url": "Eveniet perspiciatis quia fugiat omnis reprehenderit error.",
  • "synced": 3198419728271618600,
  • "system": "4er",
  • "tags": "Dolores deleniti.",
  • "testing_enabled": false,
  • "testing_metadata": {
    },
  • "updated": 7226465041984633000,
  • "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:  c2
Request Body schema: application/json
required
description
string
description of the module


 
git_tag_style
string
Git Tag Style


 
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": "Reiciendis unde recusandae soluta nisi odio consequatur.",
  • "git_tag_style": "Sed vel aperiam minus.",
  • "name": "d",
  • "org": "n82",
  • "project": "9",
  • "repository": "Ad enim error laborum perferendis saepe ipsum.",
  • "repository_branch": "main",
  • "repository_commit": "abc10ed",
  • "repository_connector": "Earum est nesciunt laudantium.",
  • "repository_path": "",
  • "system": "46",
  • "tags": "Quo impedit sapiente."
}
Create testing pipeline
Create a new testing pipeline for a given module


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


 
 Example:  Voluptatum voluptatem beatae itaque provident vero.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  w
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": "58z",
  • "project": "cs"
}
Sync module metadata
Sync the module metadata from the module registry


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


 
 Example:  Sapiente sunt asperiores et at aliquam.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Possimus maxime occaecati.
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:  6233454892184732000
header Parameters
Harness-Account
required
string
account name


 
 Example:  Enim ut 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.


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:  Sed veritatis.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  6
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": "r",
  • "pipeline_id": [
    ],
  • "project": "g",
  • "provider_connector": "Et quia molestiae et.",
  • "provisioner_type": "Error magni qui eius voluptas dolorem voluptatem.",
  • "provisioner_version": "Est sit autem ut eius.",
  • "release_pipeline": "Atque earum voluptatum."
}
Update module testing
Update module testing metadata


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


 
 Example:  Sunt debitis perspiciatis repellendus et qui blanditiis.
header Parameters
Harness-Account
required
string  [ 1 .. 128 ] characters 
Account is the internal customer account ID.


 
 Example:  j
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": "6",
  • "pipeline_id": [
    ],
  • "project": "gif",
  • "provider_connector": "Dolorem modi est quisquam quisquam nobis.",
  • "provisioner_type": "Eius minus.",
  • "provisioner_version": "Et repellendus possimus.",
  • "release_pipeline": "Earum est quia ut sunt provident accusamus."
}
List module metadata
List the module metadata from the module registry


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


 
 Example:  Quasi delectus.
query Parameters
version
required
string
version of the module


 
 Example:  version=Nihil iure.
submodule
string
submodule name


 
 Example:  submodule=Culpa vel quia ex autem autem.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Quia voluptate voluptatibus 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/{module_id}/metadata
Request samples 
Response samples 
application/json
{
  • "account": "Est voluptatem optio molestias suscipit est.",
  • "dependencies": [
    ],
  • "metadata_error": "Et sed est deleniti quia cum.",
  • "module_version": "Delectus et explicabo odit harum mollitia sint.",
  • "name": "Voluptas quae.",
  • "outputs": [
    ],
  • "providers": [
    ],
  • "resources": [
    ],
  • "submodule": [
    ],
  • "system": "Repellat iure alias voluptatem.",
  • "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:  Voluptatem temporibus.
query Parameters
version
required
string
version of the module


 
 Example:  version=Molestiae aut est.
submodule
string
submodule name


 
 Example:  submodule=Sunt qui.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Voluptas ullam qui aut quae qui eligendi.
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:  t56
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": "71i",
  • "eventType": "Est expedita est est beatae perspiciatis aspernatur.",
  • "metadata": {
    },
  • "org": "z",
  • "project": "q"
}
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:  Vero repellendus consectetur ea qui.
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=Molestias soluta magnam accusamus.
status
Array of strings
Status of the execution


 
 Example:  status=Suscipit est voluptatem assumenda excepturi vel odio.&status=Laboriosam praesentium.&status=Dolor saepe inventore tempore eligendi.
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:  sq
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:  Ea recusandae harum autem aperiam.
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": "6c",
  • "org": "n7",
  • "pipeline": "Reprehenderit eligendi voluptas veritatis id nihil facilis.",
  • "pipelineExecutionId": "Enim consectetur totam.",
  • "pipelineStageId": "Consequatur et cupiditate eum non nemo illum.",
  • "project": "d"
}
Response samples 
application/json
{
  • "account": "3d",
  • "created": 6473187074569455000,
  • "metadata": {
    },
  • "moduleId": "Magnam eos beatae voluptas magni odio.",
  • "org": "p",
  • "project": "7kg",
  • "status": "Autem quisquam atque ullam tempore."
}
Create module data
Create a new module in the module registry


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


 
 Example:  Eveniet eius voluptatum molestiae aut.
system
required
string
system name


 
 Example:  Unde ullam earum quia.
version
required
string
version of the module


 
 Example:  Ad occaecati vel.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Delectus at odio.
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": "Veniam et quod.",
  • "error": {
    },
  • "examples_paths": [
    ],
  • "git_tag": "Ipsam omnis earum deserunt aut vel.",
  • "metadata": "Dignissimos animi aspernatur voluptatem minus.",
  • "repo_url": "Nesciunt tempore facilis illum et.",
  • "submodule_name": "Dicta aut sapiente voluptatem in.",
  • "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:  Id fugit id cupiditate.
system
required
string
system name


 
 Example:  Sit molestiae.
version
required
string
version of the module


 
 Example:  Beatae ipsam repellat voluptas et sit.
query Parameters
submoduleName
string
submodule name


 
 Example:  submoduleName=Asperiores nulla rerum est.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Molestiae labore ullam rem eius rem in.
Content-Length
integer <int64> 
Size in bytes of the readme


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


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


 
 Example:  r
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 
query Parameters
org
string
organization name


 
 Example:  org=Optio incidunt quos.
project
string
project name


 
 Example:  project=Voluptas non consequatur perferendis.
header Parameters
Harness-Account
required
string
account name


 
 Example:  Ex perferendis ut 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/connectors
Request samples 
Response samples 
application/json
[
  • "Quibusdam voluptatibus.",
  • "Eum dolores nemo sint consequatur ut.",
  • "Et totam perspiciatis soluta et quaerat est."
]
Download module
Download a module given a specific version


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


 
 Example:  Suscipit qui.
name
required
string
module name


 
 Example:  Eveniet fugiat eveniet dolores nesciunt ut numquam.
system
required
string
system name


 
 Example:  Alias sit error quo quo.
version
required
string
version of the module


 
 Example:  Error non porro nesciunt voluptatem aliquam vitae.
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:  Ipsa suscipit dolor ea.
name
required
string
module name


 
 Example:  Accusantium occaecati.
system
required
string
system name


 
 Example:  Et quis.
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