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,ASC

header Parameters

Harness-Account

required

string

account name

Example: Ut 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/api/modules

Request samples

curl
Java
Go

Response samples

application/json

[{"account": "2",
"created": 6628913572060780000,
"description": "Fugiat velit veritatis.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Veritatis culpa ullam recusandae.",
"name": "zq",
"repository": "Vero nulla iusto voluptatibus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Molestiae perferendis sunt et.",
"repository_path": "",
"repository_url": "Voluptatibus quaerat doloribus nihil temporibus.",
"synced": 129043740818561220,
"system": "8a",
"tags": "Nulla nisi.",
"testing_enabled": true,
"testing_metadata": {"account": "q8",
"org": "1c2",
"pipelines": ["Voluptatem praesentium inventore tempore cupiditate.",
"Reprehenderit voluptatem ullam voluptas nihil nihil ullam."
],
"project": "r",
"provider_connector": "Libero quae laudantium accusantium.",
"provisioner_type": "Eum deserunt rerum voluptates non.",
"provisioner_version": "Sunt sed excepturi ullam tempore omnis et."
},
"updated": 7797620594381792000,
"versions": ["Suscipit tenetur.",
"Voluptas maiores et placeat aut animi."
]
},
{"account": "2",
"created": 6628913572060780000,
"description": "Fugiat velit veritatis.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Veritatis culpa ullam recusandae.",
"name": "zq",
"repository": "Vero nulla iusto voluptatibus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Molestiae perferendis sunt et.",
"repository_path": "",
"repository_url": "Voluptatibus quaerat doloribus nihil temporibus.",
"synced": 129043740818561220,
"system": "8a",
"tags": "Nulla nisi.",
"testing_enabled": true,
"testing_metadata": {"account": "q8",
"org": "1c2",
"pipelines": ["Voluptatem praesentium inventore tempore cupiditate.",
"Reprehenderit voluptatem ullam voluptas nihil nihil ullam."
],
"project": "r",
"provider_connector": "Libero quae laudantium accusantium.",
"provisioner_type": "Eum deserunt rerum voluptates non.",
"provisioner_version": "Sunt sed excepturi ullam tempore omnis et."
},
"updated": 7797620594381792000,
"versions": ["Suscipit tenetur.",
"Voluptas maiores et placeat aut animi."
]
}
]

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: 6

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

Payload
curl
Java
Go

application/json

{"description": "Repudiandae distinctio sed saepe aliquid.",
"name": "t7t",
"repository": "Ut porro quos.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Aut rem impedit vel laborum voluptatum.",
"repository_path": "",
"system": "g",
"tags": "Voluptatem explicabo quam consequatur consequatur repudiandae."
}

Response samples

application/json

{"account": "ls",
"created": 3904105647498163000,
"description": "Voluptas alias quasi tenetur aut.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "30",
"repository": "Quisquam fugit qui distinctio.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Sed dolor non.",
"repository_path": "",
"system": "3h",
"tags": "Velit maiores.",
"updated": 8215704151359631000
}

Delete module

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Et eum.

header Parameters

Harness-Account

required

string

account name

Example: Repellat corporis illo temporibus.

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

curl
Java
Go

List module by id

List a module from the module registry by ID

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Enim totam alias.

header Parameters

Harness-Account

required

string

account name

Example: Voluptas iure 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/api/modules/{id}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "9t",
"created": 3618497296592500000,
"description": "Ratione laudantium non sit unde.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Sed ipsa facilis pariatur autem cupiditate qui.",
"name": "vcs",
"repository": "Odit et ratione.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nam dignissimos voluptatem aut deserunt qui tempore.",
"repository_path": "",
"repository_url": "Nisi laudantium odio.",
"synced": 1205272519119392300,
"system": "fq",
"tags": "Voluptatem rerum.",
"testing_enabled": false,
"testing_metadata": {"account": "z4n",
"org": "zx2",
"pipelines": ["Ipsa voluptatem voluptas aliquid ipsam atque.",
"Inventore aut est autem.",
"Voluptates enim fugit et."
],
"project": "4q",
"provider_connector": "Ducimus officia architecto odio iure.",
"provisioner_type": "Dolorum rerum sed voluptatibus veniam fuga optio.",
"provisioner_version": "Magni qui vel eaque."
},
"updated": 9067819614222991000,
"versions": ["In vero perspiciatis molestiae ut.",
"Eveniet eligendi dicta.",
"Nemo quia quia qui."
]
}

Update module

Update a module in the module registry

Securityx-api-key

Request

path Parameters

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: g

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

Payload
curl
Java
Go

application/json

{"description": "Et est quam.",
"name": "72d",
"repository": "Recusandae et suscipit ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Harum id ut rerum qui.",
"repository_path": "",
"system": "i",
"tags": "Cumque modi sunt aliquam."
}

Create testing pipeline

Create a new testing pipeline for a given module

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Earum pariatur est.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: v

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

Payload
curl
Java
Go

application/json

{"org": "y2f",
"project": "rhj"
}

Sync module metadata

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Ratione et.

header Parameters

Harness-Account

required

string

account name

Example: Quas porro.

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

curl
Java
Go

Disable testing

Disable testing for a module

Securityx-api-key

Request

path Parameters

required

integer <int64>

module id

Example: 6288555645295361000

header Parameters

Harness-Account

required

string

account name

Example: Maiores commodi autem.

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

curl
Java
Go

Enable testing

Enable testing for a module

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Aliquam et enim similique labore dolor.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 9

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

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

Payload
curl
Java
Go

application/json

{"org": "xn",
"pipeline_id": ["Numquam at minus placeat praesentium.",
"Vero eum accusantium voluptatibus amet cupiditate facere.",
"Sapiente sapiente.",
"Facilis sint."
],
"project": "m",
"provider_connector": "Aut fugiat qui tempore maiores.",
"provisioner_type": "Laboriosam qui.",
"provisioner_version": "Illo natus."
}

Update module testing

Update module testing metadata

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Facere nobis vel.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: nkl

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

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

Payload
curl
Java
Go

application/json

{"org": "2g",
"pipeline_id": ["Itaque vel et tenetur.",
"Voluptatem voluptatem sint.",
"Aut incidunt quidem autem aspernatur a culpa.",
"Eveniet qui veniam."
],
"project": "tc",
"provider_connector": "Harum impedit.",
"provisioner_type": "Optio eos rerum consequatur veritatis nesciunt alias.",
"provisioner_version": "Quod omnis ab quos."
}

List module metadata

List the module metadata from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Similique voluptas debitis nihil.

query Parameters

version required	string version of the module Example: version=Laudantium ipsam culpa eaque magni.
submodule	string submodule name Example: submodule=Blanditiis et aut explicabo ipsam ea.

header Parameters

Harness-Account

required

string

account name

Example: Voluptatibus officiis rerum deleniti aspernatur ut.

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

curl
Java
Go

Response samples

application/json

{"account": "Fugiat dignissimos a.",
"dependencies": [{"dependency_name": "Ea tempore.",
"dependency_source": "Tenetur ut tempore iusto qui.",
"dependency_version": "Eveniet ipsam occaecati nihil id."
},
{"dependency_name": "Ea tempore.",
"dependency_source": "Tenetur ut tempore iusto qui.",
"dependency_version": "Eveniet ipsam occaecati nihil id."
}
],
"metadata_error": "Ullam minima optio eveniet iusto quia dolor.",
"module_version": "Dolorum amet nemo beatae alias odio.",
"name": "Quo architecto.",
"outputs": [{"output_description": "Est deleniti nihil earum id.",
"output_name": "Vero vero aut dolorem consequatur.",
"output_sensitive": true
},
{"output_description": "Est deleniti nihil earum id.",
"output_name": "Vero vero aut dolorem consequatur.",
"output_sensitive": true
},
{"output_description": "Est deleniti nihil earum id.",
"output_name": "Vero vero aut dolorem consequatur.",
"output_sensitive": true
}
],
"providers": [{"provider_name": "Pariatur dolores aut perspiciatis.",
"provider_source": "Quo harum nesciunt autem debitis optio animi.",
"provider_version": "Inventore voluptatem impedit est."
},
{"provider_name": "Pariatur dolores aut perspiciatis.",
"provider_source": "Quo harum nesciunt autem debitis optio animi.",
"provider_version": "Inventore voluptatem impedit est."
}
],
"resources": [{"resource_name": "Fugit et ullam est possimus.",
"resource_type": "Rerum voluptatum qui earum sit pariatur aliquid."
},
{"resource_name": "Fugit et ullam est possimus.",
"resource_type": "Rerum voluptatum qui earum sit pariatur aliquid."
}
],
"submodule": ["Dolore eum quod debitis corrupti.",
"Omnis repellat.",
"Nostrum nesciunt repellendus molestias.",
"Sed assumenda."
],
"system": "Labore et dolor.",
"variables": [{"variable_default": "Dolores earum animi aliquid ea nihil alias.",
"variable_description": "Et praesentium aut omnis enim quas quas.",
"variable_name": "Aut enim similique quo id ab.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "Id voluptatum necessitatibus est impedit occaecati incidunt."
},
{"variable_default": "Dolores earum animi aliquid ea nihil alias.",
"variable_description": "Et praesentium aut omnis enim quas quas.",
"variable_name": "Aut enim similique quo id ab.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "Id voluptatum necessitatibus est impedit occaecati incidunt."
},
{"variable_default": "Dolores earum animi aliquid ea nihil alias.",
"variable_description": "Et praesentium aut omnis enim quas quas.",
"variable_name": "Aut enim similique quo id ab.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "Id voluptatum necessitatibus est impedit occaecati incidunt."
},
{"variable_default": "Dolores earum animi aliquid ea nihil alias.",
"variable_description": "Et praesentium aut omnis enim quas quas.",
"variable_name": "Aut enim similique quo id ab.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "Id voluptatum necessitatibus est impedit occaecati incidunt."
}
]
}

List module readme

List the module readme from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Aperiam blanditiis ut explicabo vitae dolorum debitis.

query Parameters

version required	string version of the module Example: version=Ratione aliquam soluta ullam nam.
submodule	string submodule name Example: submodule=Nam mollitia quia.

header Parameters

Harness-Account

required

string

account name

Example: Aut in voluptatem magni quia quibusdam.

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

curl
Java
Go

Response samples

application/json

"string"

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: v6g

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

Payload
curl
Java
Go

application/json

{"account": "sq",
"eventType": "Aut aliquam perferendis officiis impedit.",
"metadata": {"pipeline": "Quod molestiae quis.",
"pipeline_execution_id": "Architecto nostrum dolor voluptatem sit.",
"pipeline_execution_number": "Vero ratione.",
"pipeline_name": "Praesentium doloribus voluptas quis nihil.",
"pipeline_stage_id": "Debitis veritatis laudantium explicabo accusantium voluptatibus velit.",
"trigger": {"Excepturi reprehenderit.": "Non in tenetur dolor voluptatem.",
"Maiores numquam impedit.": "Quasi magni facilis iure.",
"Ut velit at inventore.": "At dolores laborum et dolorum quo repudiandae."
}
},
"org": "b",
"project": "n"
}

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: Saepe quia ipsum quis aut.

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=Quasi veritatis reprehenderit dolorem aspernatur minus.
status	Array of strings Status of the execution Example: status=Aut reiciendis laudantium in eligendi sed.&status=Odit sed.
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: dm

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

curl
Java
Go

Response samples

application/json

[{"account": "1mn",
"created": 4241233795140433400,
"metadata": {"pipeline": "Natus libero quia quis earum.",
"pipeline_execution_id": "Corporis quo eaque illum.",
"pipeline_execution_number": "Non consequatur corporis cum perferendis illum architecto.",
"pipeline_name": "Molestiae minima deserunt sapiente rerum rerum dicta.",
"pipeline_stage_id": "Aut provident suscipit soluta hic occaecati dolore.",
"trigger": {"Culpa eum ea voluptates quia.": "Odit quis eum.",
"Est nostrum placeat aliquid.": "Laborum nobis et natus assumenda aliquam delectus.",
"Sit sed velit et.": "Qui provident aut aut quam corrupti."
}
},
"moduleId": "Ratione sunt magnam est dolor.",
"org": "73",
"project": "9n",
"status": "Natus qui dignissimos explicabo."
},
{"account": "1mn",
"created": 4241233795140433400,
"metadata": {"pipeline": "Natus libero quia quis earum.",
"pipeline_execution_id": "Corporis quo eaque illum.",
"pipeline_execution_number": "Non consequatur corporis cum perferendis illum architecto.",
"pipeline_name": "Molestiae minima deserunt sapiente rerum rerum dicta.",
"pipeline_stage_id": "Aut provident suscipit soluta hic occaecati dolore.",
"trigger": {"Culpa eum ea voluptates quia.": "Odit quis eum.",
"Est nostrum placeat aliquid.": "Laborum nobis et natus assumenda aliquam delectus.",
"Sit sed velit et.": "Qui provident aut aut quam corrupti."
}
},
"moduleId": "Ratione sunt magnam est dolor.",
"org": "73",
"project": "9n",
"status": "Natus qui dignissimos explicabo."
},
{"account": "1mn",
"created": 4241233795140433400,
"metadata": {"pipeline": "Natus libero quia quis earum.",
"pipeline_execution_id": "Corporis quo eaque illum.",
"pipeline_execution_number": "Non consequatur corporis cum perferendis illum architecto.",
"pipeline_name": "Molestiae minima deserunt sapiente rerum rerum dicta.",
"pipeline_stage_id": "Aut provident suscipit soluta hic occaecati dolore.",
"trigger": {"Culpa eum ea voluptates quia.": "Odit quis eum.",
"Est nostrum placeat aliquid.": "Laborum nobis et natus assumenda aliquam delectus.",
"Sit sed velit et.": "Qui provident aut aut quam corrupti."
}
},
"moduleId": "Ratione sunt magnam est dolor.",
"org": "73",
"project": "9n",
"status": "Natus qui dignissimos explicabo."
}
]

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: Et ut dolorem quisquam ratione animi repellat.

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

Payload
curl
Java
Go

application/json

{"account": "fo",
"org": "3",
"pipeline": "Quae eligendi quasi in quis exercitationem dolores.",
"pipelineExecutionId": "Eum quasi non modi consectetur reiciendis consequatur.",
"pipelineStageId": "Consequatur laudantium cum aperiam corrupti.",
"project": "7h8"
}

Response samples

application/json

{"account": "r",
"created": 7421590203888071000,
"metadata": {"pipeline": "Quisquam nesciunt sunt.",
"pipeline_execution_id": "Id nemo.",
"pipeline_execution_number": "Veniam repudiandae odit omnis quis.",
"pipeline_name": "Placeat voluptatem veniam sint aperiam ratione.",
"pipeline_stage_id": "Vero sit.",
"trigger": {"Eum odit ducimus.": "Et ut et sunt veritatis aut.",
"Quaerat omnis tempore.": "Quia minima nemo aut harum vel."
}
},
"moduleId": "Est pariatur delectus.",
"org": "4",
"project": "64",
"status": "Quis et aut et dicta perferendis ratione."
}

Create module data

Create a new module in the module registry

Securityx-api-key

Request

path Parameters

name required	string module name Example: Et commodi fuga consequatur aut.
system required	string system name Example: Earum ipsam corrupti.
version required	string version of the module Example: Rem aperiam voluptatem corporis sint.

header Parameters

Harness-Account

required

string

account name

Example: Animi maiores quisquam accusamus rerum nihil consectetur.

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

Payload
curl
Java
Go

application/json

{"download_url": "Quia ab dolor dolores velit non.",
"error": {"Sit voluptatem fugit officia illum.": "Voluptate unde."
},
"examples_paths": ["Cumque aut quia praesentium.",
"Sint laboriosam iste iusto totam id nostrum.",
"Accusantium aperiam est et aut temporibus."
],
"git_tag": "Natus tenetur nam dolore.",
"metadata": "In sunt sed qui enim.",
"repo_url": "Veniam quo quas hic dolorum.",
"submodule_name": "Magnam et repellendus.",
"submodule_paths": ["Rerum rerum at quo nostrum aliquid.",
"Aut voluptas qui numquam molestiae magni est.",
"Dolor et et debitis."
]
}

Create module readme

Endpoint to push the Readme for a given module

Securityx-api-key

Request

path Parameters

name required	string module name Example: Animi cum ducimus aperiam repellat.
system required	string system name Example: Similique expedita ut et est eaque.
version required	string version of the module Example: Distinctio earum rerum eum omnis dolor ea.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Repudiandae nihil sed occaecati harum quis porro.

header Parameters

Harness-Account required	string account name Example: Autem a voluptas.
Content-Length	integer <int64> Size in bytes of the readme Example: 8204149501798218000

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

curl
Java
Go

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: n

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

Payload
curl
Java
Go

application/json

{"error": {"Velit labore ex quisquam qui.": "Quo cumque molestias occaecati."
},
"tags": ["Voluptatem ullam odit porro qui voluptas quam.",
"Perferendis beatae.",
"Qui earum quos."
]
}

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: Natus corporis labore rem velit corporis ut.

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

curl
Java
Go

Response samples

application/json

["Necessitatibus aliquid.",
"Eos et dolor aut."
]

Download module

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Enim corporis.
name required	string module name Example: Officia et voluptas vitae.
system required	string system name Example: Earum repudiandae quod.
version required	string version of the module Example: Nesciunt at et.

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

curl
Java
Go

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: Culpa ab dolore qui aut rerum ut.
name required	string module name Example: Vel tempora aut.
system required	string system name Example: Autem ea sunt.

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

curl
Java
Go

Response samples

application/json

{"modules": [{"versions": [{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
}
]
},
{"versions": [{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
}
]
},
{"versions": [{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
},
{"git_version": "Fugit consequuntur et voluptatum iure eum.",
"module_version": "Qui quia occaecati consequatur esse."
}
]
}
]
}

➔ Next to workspaces

module-registry

List modules

query Parameters

header Parameters

Create module

header Parameters

Request Body schema: application/jsonrequired

Delete module

path Parameters

header Parameters

List module by id

path Parameters

header Parameters

Update module

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Create testing pipeline

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Sync module metadata

path Parameters

header Parameters

Disable testing

path Parameters

header Parameters

Enable testing

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Update module testing

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List module metadata

path Parameters

query Parameters

header Parameters

List module readme

path Parameters

query Parameters

header Parameters

Send an event related with a module execution

path Parameters

Request Body schema: application/jsonrequired

List executions for a specific module

path Parameters

query Parameters

header Parameters

Create a new module execution

path Parameters

Request Body schema: application/jsonrequired

Create module data

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Create module readme

path Parameters

query Parameters

header Parameters

Create module tags

path Parameters

header Parameters

Request Body schema: application/jsonrequired

List connectors

header Parameters

Download module

path Parameters

List module versions

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required