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

header Parameters

Harness-Account

required

string

account name

Example: Ut aut exercitationem accusamus repellat quidem.

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": "4",
"created": 3204089829265515500,
"description": "Eius nostrum sequi voluptas deleniti velit magnam.",
"git_tag_style": "Sed eum occaecati soluta deleniti.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Eveniet sunt quam nobis qui commodi.",
"name": "q",
"org": "etd",
"project": "t",
"repository": "Laboriosam reprehenderit enim.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Earum fugit qui laboriosam.",
"repository_path": "",
"repository_url": "Sint unde saepe quod corrupti ea quae.",
"synced": 2015026232414189000,
"system": "7c",
"tags": "Quia ipsum illo tenetur expedita est ut.",
"testing_enabled": false,
"testing_metadata": {"account": "xtc",
"org": "la3",
"pipelines": ["Quis fugit laborum laboriosam maiores error porro.",
"Quisquam temporibus accusantium in illo quis nihil.",
"Odio quo."
],
"project": "wwf",
"provider_connector": "Voluptatum cupiditate.",
"provisioner_type": "Error repellat accusantium nesciunt autem ipsum.",
"provisioner_version": "Commodi quia laboriosam.",
"release_pipeline": "Ea omnis."
},
"updated": 3125018940488123400,
"versions": ["Eveniet illo autem eveniet laboriosam molestiae.",
"Iusto et et sapiente eum.",
"Debitis sit minima voluptas ipsum ut quasi.",
"Consequatur ipsa voluptas eligendi quasi."
]
},
{"account": "4",
"created": 3204089829265515500,
"description": "Eius nostrum sequi voluptas deleniti velit magnam.",
"git_tag_style": "Sed eum occaecati soluta deleniti.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Eveniet sunt quam nobis qui commodi.",
"name": "q",
"org": "etd",
"project": "t",
"repository": "Laboriosam reprehenderit enim.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Earum fugit qui laboriosam.",
"repository_path": "",
"repository_url": "Sint unde saepe quod corrupti ea quae.",
"synced": 2015026232414189000,
"system": "7c",
"tags": "Quia ipsum illo tenetur expedita est ut.",
"testing_enabled": false,
"testing_metadata": {"account": "xtc",
"org": "la3",
"pipelines": ["Quis fugit laborum laboriosam maiores error porro.",
"Quisquam temporibus accusantium in illo quis nihil.",
"Odio quo."
],
"project": "wwf",
"provider_connector": "Voluptatum cupiditate.",
"provisioner_type": "Error repellat accusantium nesciunt autem ipsum.",
"provisioner_version": "Commodi quia laboriosam.",
"release_pipeline": "Ea omnis."
},
"updated": 3125018940488123400,
"versions": ["Eveniet illo autem eveniet laboriosam molestiae.",
"Iusto et et sapiente eum.",
"Debitis sit minima voluptas ipsum ut quasi.",
"Consequatur ipsa voluptas eligendi quasi."
]
},
{"account": "4",
"created": 3204089829265515500,
"description": "Eius nostrum sequi voluptas deleniti velit magnam.",
"git_tag_style": "Sed eum occaecati soluta deleniti.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Eveniet sunt quam nobis qui commodi.",
"name": "q",
"org": "etd",
"project": "t",
"repository": "Laboriosam reprehenderit enim.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Earum fugit qui laboriosam.",
"repository_path": "",
"repository_url": "Sint unde saepe quod corrupti ea quae.",
"synced": 2015026232414189000,
"system": "7c",
"tags": "Quia ipsum illo tenetur expedita est ut.",
"testing_enabled": false,
"testing_metadata": {"account": "xtc",
"org": "la3",
"pipelines": ["Quis fugit laborum laboriosam maiores error porro.",
"Quisquam temporibus accusantium in illo quis nihil.",
"Odio quo."
],
"project": "wwf",
"provider_connector": "Voluptatum cupiditate.",
"provisioner_type": "Error repellat accusantium nesciunt autem ipsum.",
"provisioner_version": "Commodi quia laboriosam.",
"release_pipeline": "Ea omnis."
},
"updated": 3125018940488123400,
"versions": ["Eveniet illo autem eveniet laboriosam molestiae.",
"Iusto et et sapiente eum.",
"Debitis sit minima voluptas ipsum ut quasi.",
"Consequatur ipsa voluptas eligendi quasi."
]
}
]

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

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

Payload
curl
Java
Go

application/json

{"description": "Nostrum voluptas consectetur perferendis ipsa.",
"git_tag_style": "In accusantium sunt.",
"name": "o5",
"org": "vz",
"project": "f31",
"repository": "Dolor tempore ipsa aut fugit ut.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Porro enim molestiae laborum molestiae vero.",
"repository_path": "",
"system": "d6",
"tags": "Distinctio beatae."
}

Response samples

application/json

{"account": "a",
"created": 6646991267384452000,
"description": "Repellat iure alias voluptatem.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "l",
"repository": "Maiores a ad.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Dolores veritatis.",
"repository_path": "",
"system": "16",
"tags": "Delectus et explicabo odit harum mollitia sint.",
"updated": 1996121038576849700
}

Delete module

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Assumenda qui voluptas quia quibusdam earum.

header Parameters

Harness-Account

required

string

account name

Example: Est sunt minus sed repellendus voluptatem.

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: A pariatur consequatur est.

header Parameters

Harness-Account

required

string

account name

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

Request samples

curl
Java
Go

Response samples

application/json

{"account": "ema",
"created": 1115554375052084000,
"description": "Laborum fugiat.",
"git_tag_style": "Odit voluptatem est id aut hic doloremque.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Dignissimos tempore ratione.",
"name": "u",
"org": "gg",
"project": "4",
"repository": "Ipsam consequatur ad.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Vero quis necessitatibus qui eligendi.",
"repository_path": "",
"repository_url": "Sit cum praesentium necessitatibus aut earum et.",
"synced": 2483636887108303000,
"system": "xn",
"tags": "Tenetur et deserunt.",
"testing_enabled": false,
"testing_metadata": {"account": "422",
"org": "k1",
"pipelines": ["Reiciendis natus.",
"Explicabo eos.",
"Illum aliquid.",
"Libero harum velit quod in."
],
"project": "med",
"provider_connector": "Et accusantium commodi.",
"provisioner_type": "Blanditiis non ut.",
"provisioner_version": "Neque consequatur.",
"release_pipeline": "Quibusdam ut."
},
"updated": 2081494750578636000,
"versions": ["Praesentium illum eius.",
"Dolor exercitationem officiis."
]
}

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

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

Payload
curl
Java
Go

application/json

{"description": "Perspiciatis vitae harum suscipit quia modi et.",
"git_tag_style": "Est dignissimos animi.",
"name": "q",
"org": "fp",
"project": "q8",
"repository": "Maiores quisquam error et voluptas aspernatur autem.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Vitae esse sit fuga.",
"repository_path": "",
"system": "u",
"tags": "Quae similique perspiciatis ea odit temporibus."
}

Create testing pipeline

Create a new testing pipeline for a given module

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Quam dolore sunt.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 0

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": "eg",
"project": "zrk"
}

Sync module metadata

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Dolores facilis.

header Parameters

Harness-Account

required

string

account name

Example: Accusantium cum saepe.

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

header Parameters

Harness-Account

required

string

account name

Example: Enim perferendis reiciendis accusamus et dolorem sit.

Responses

204

No Content response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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: Repellendus magni aut et eius impedit.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 36

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

Payload
curl
Java
Go

application/json

{"org": "z8k",
"pipeline_id": ["In maxime et ad quos quia.",
"Voluptas reprehenderit.",
"Ea mollitia."
],
"project": "f",
"provider_connector": "Est maxime ut explicabo maxime tempora.",
"provisioner_type": "Hic omnis sapiente.",
"provisioner_version": "Qui quaerat voluptatem maxime.",
"release_pipeline": "Nostrum dolore est sit ut."
}

Update module testing

Update module testing metadata

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Veniam assumenda.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 23t

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

Payload
curl
Java
Go

application/json

{"org": "9p3",
"pipeline_id": ["Nemo quod aperiam ut debitis impedit.",
"Corrupti numquam accusantium.",
"Quisquam laborum fugiat a.",
"Harum et amet animi error."
],
"project": "q",
"provider_connector": "Dolore voluptatum dignissimos ut.",
"provisioner_type": "Dolore aut eum id aut dolor.",
"provisioner_version": "Assumenda illum dolores quis ratione.",
"release_pipeline": "Nesciunt totam omnis dolor facere."
}

List module metadata

List the module metadata from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Repellat cupiditate earum laboriosam ipsam.

query Parameters

version required	string version of the module Example: version=Enim sit quia.
submodule	string submodule name Example: submodule=Veniam facere ipsa deleniti unde et.

header Parameters

Harness-Account

required

string

account name

Example: Sequi illum 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/api/modules/{module_id}/metadata

Request samples

curl
Java
Go

Response samples

application/json

{"account": "Atque earum voluptatum.",
"dependencies": [{"dependency_name": "Laudantium ut.",
"dependency_source": "Consequatur et ex nihil necessitatibus ut.",
"dependency_version": "Qui non atque dolor."
},
{"dependency_name": "Laudantium ut.",
"dependency_source": "Consequatur et ex nihil necessitatibus ut.",
"dependency_version": "Qui non atque dolor."
}
],
"metadata_error": "Et ut.",
"module_version": "In et sit ut id delectus illum.",
"name": "Cumque laudantium et ea aut.",
"outputs": [{"output_description": "Sint dolor.",
"output_name": "Tempore dolorum hic tenetur perferendis est.",
"output_sensitive": false
},
{"output_description": "Sint dolor.",
"output_name": "Tempore dolorum hic tenetur perferendis est.",
"output_sensitive": false
},
{"output_description": "Sint dolor.",
"output_name": "Tempore dolorum hic tenetur perferendis est.",
"output_sensitive": false
}
],
"providers": [{"provider_name": "Ullam dolorem.",
"provider_source": "Impedit qui natus.",
"provider_version": "Molestiae pariatur excepturi laborum esse porro consequatur."
},
{"provider_name": "Ullam dolorem.",
"provider_source": "Impedit qui natus.",
"provider_version": "Molestiae pariatur excepturi laborum esse porro consequatur."
},
{"provider_name": "Ullam dolorem.",
"provider_source": "Impedit qui natus.",
"provider_version": "Molestiae pariatur excepturi laborum esse porro consequatur."
},
{"provider_name": "Ullam dolorem.",
"provider_source": "Impedit qui natus.",
"provider_version": "Molestiae pariatur excepturi laborum esse porro consequatur."
}
],
"resources": [{"resource_name": "Repudiandae quo deleniti facere quaerat nihil.",
"resource_type": "Delectus officiis."
},
{"resource_name": "Repudiandae quo deleniti facere quaerat nihil.",
"resource_type": "Delectus officiis."
},
{"resource_name": "Repudiandae quo deleniti facere quaerat nihil.",
"resource_type": "Delectus officiis."
},
{"resource_name": "Repudiandae quo deleniti facere quaerat nihil.",
"resource_type": "Delectus officiis."
}
],
"submodule": ["In voluptas nostrum.",
"Corporis ipsa et quas sit soluta vero.",
"Labore autem autem illum ut beatae."
],
"system": "Et ut et vel.",
"variables": [{"variable_default": "Culpa voluptas fugit beatae.",
"variable_description": "Error error illum.",
"variable_name": "Vel placeat vitae ex ex.",
"variable_required": false,
"variable_sensitive": false,
"variable_type": "Dolore ex esse magnam dicta in rerum."
},
{"variable_default": "Culpa voluptas fugit beatae.",
"variable_description": "Error error illum.",
"variable_name": "Vel placeat vitae ex ex.",
"variable_required": false,
"variable_sensitive": false,
"variable_type": "Dolore ex esse magnam dicta in rerum."
},
{"variable_default": "Culpa voluptas fugit beatae.",
"variable_description": "Error error illum.",
"variable_name": "Vel placeat vitae ex ex.",
"variable_required": false,
"variable_sensitive": false,
"variable_type": "Dolore ex esse magnam dicta in rerum."
},
{"variable_default": "Culpa voluptas fugit beatae.",
"variable_description": "Error error illum.",
"variable_name": "Vel placeat vitae ex ex.",
"variable_required": false,
"variable_sensitive": false,
"variable_type": "Dolore ex esse magnam dicta in rerum."
}
]
}

List module readme

List the module readme from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Architecto eos eos quia similique atque expedita.

query Parameters

version required	string version of the module Example: version=Quaerat libero occaecati aperiam.
submodule	string submodule name Example: submodule=Quibusdam eos aliquid amet saepe non.

header Parameters

Harness-Account

required

string

account name

Example: Mollitia dolorum facere.

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

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": "3d",
"eventType": "Repellendus assumenda ratione libero.",
"metadata": {"pipeline": "Ab dolorum nihil reprehenderit rerum.",
"pipeline_execution_id": "Est maiores beatae hic.",
"pipeline_execution_number": "Corrupti ut voluptatem sit quod dolor.",
"pipeline_name": "Voluptas voluptatum veritatis repellendus eligendi quo qui.",
"pipeline_stage_id": "Eaque vel ut recusandae nisi cupiditate.",
"trigger": {"Et sequi.": "Et explicabo aut autem nam."
}
},
"org": "7",
"project": "95"
}

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: Et ipsa rem recusandae consequatur animi nam.

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=Dolorem ullam eos.
status	Array of strings Status of the execution Example: status=Soluta est ea ea voluptas similique.&status=Sunt eum quae quia eos.&status=Dolorem vero aliquid recusandae.
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: 7ww

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": "w7x",
"created": 5373064796665811000,
"metadata": {"pipeline": "Quas ipsam.",
"pipeline_execution_id": "Mollitia libero.",
"pipeline_execution_number": "Veniam vel a pariatur vero.",
"pipeline_name": "Nam eveniet.",
"pipeline_stage_id": "Quasi quo nulla sit consequatur natus fugiat.",
"trigger": {"Consequatur veritatis non.": "Quo ratione sed.",
"Qui omnis magnam maxime nesciunt.": "Qui aperiam sint."
}
},
"moduleId": "Cumque est sunt.",
"org": "br",
"project": "vjd",
"status": "Est eos explicabo iste tempore ipsa."
},
{"account": "w7x",
"created": 5373064796665811000,
"metadata": {"pipeline": "Quas ipsam.",
"pipeline_execution_id": "Mollitia libero.",
"pipeline_execution_number": "Veniam vel a pariatur vero.",
"pipeline_name": "Nam eveniet.",
"pipeline_stage_id": "Quasi quo nulla sit consequatur natus fugiat.",
"trigger": {"Consequatur veritatis non.": "Quo ratione sed.",
"Qui omnis magnam maxime nesciunt.": "Qui aperiam sint."
}
},
"moduleId": "Cumque est sunt.",
"org": "br",
"project": "vjd",
"status": "Est eos explicabo iste tempore ipsa."
},
{"account": "w7x",
"created": 5373064796665811000,
"metadata": {"pipeline": "Quas ipsam.",
"pipeline_execution_id": "Mollitia libero.",
"pipeline_execution_number": "Veniam vel a pariatur vero.",
"pipeline_name": "Nam eveniet.",
"pipeline_stage_id": "Quasi quo nulla sit consequatur natus fugiat.",
"trigger": {"Consequatur veritatis non.": "Quo ratione sed.",
"Qui omnis magnam maxime nesciunt.": "Qui aperiam sint."
}
},
"moduleId": "Cumque est sunt.",
"org": "br",
"project": "vjd",
"status": "Est eos explicabo iste tempore ipsa."
},
{"account": "w7x",
"created": 5373064796665811000,
"metadata": {"pipeline": "Quas ipsam.",
"pipeline_execution_id": "Mollitia libero.",
"pipeline_execution_number": "Veniam vel a pariatur vero.",
"pipeline_name": "Nam eveniet.",
"pipeline_stage_id": "Quasi quo nulla sit consequatur natus fugiat.",
"trigger": {"Consequatur veritatis non.": "Quo ratione sed.",
"Qui omnis magnam maxime nesciunt.": "Qui aperiam sint."
}
},
"moduleId": "Cumque est sunt.",
"org": "br",
"project": "vjd",
"status": "Est eos explicabo iste tempore ipsa."
}
]

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 non cumque ab voluptate voluptas quidem.

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": "w6v",
"org": "k",
"pipeline": "Quaerat asperiores voluptates corrupti fuga.",
"pipelineExecutionId": "Ipsum sint consequuntur necessitatibus quia.",
"pipelineStageId": "Non quam cum nisi.",
"project": "u"
}

Response samples

application/json

{"account": "car",
"created": 8918672159886281000,
"metadata": {"pipeline": "In iste quisquam dolores necessitatibus nihil.",
"pipeline_execution_id": "Est quod aliquid est.",
"pipeline_execution_number": "Ea vel qui sint.",
"pipeline_name": "Porro deleniti voluptatibus tenetur omnis eum adipisci.",
"pipeline_stage_id": "Qui enim nemo.",
"trigger": {"Et non sed illum occaecati quis.": "Quisquam corporis veritatis rerum officia.",
"Illo ut itaque minima alias.": "Voluptas quibusdam error voluptates sunt."
}
},
"moduleId": "Voluptatem aliquid.",
"org": "4",
"project": "va",
"status": "Consequatur adipisci id suscipit."
}

Create module data

Create a new module in the module registry

Securityx-api-key

Request

path Parameters

name required	string module name Example: Voluptatem labore aut tempora est eos.
system required	string system name Example: Sed voluptatum.
version required	string version of the module Example: Nobis corrupti sequi qui aliquam ea.

header Parameters

Harness-Account

required

string

account name

Example: Qui tempora non id soluta velit.

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": "Nihil facilis.",
"error": {"Ratione qui aperiam necessitatibus provident.": "Eveniet quas alias soluta exercitationem eum quasi.",
"Repellendus possimus ullam aliquid officia.": "Aut magnam dolores.",
"Voluptas necessitatibus libero in.": "Debitis neque."
},
"examples_paths": ["Quasi sapiente nostrum.",
"Et non."
],
"git_tag": "Quia a sunt reprehenderit corporis tempora.",
"metadata": "Eligendi voluptas veritatis.",
"repo_url": "Et cumque a.",
"submodule_name": "Reiciendis maxime tempora voluptatem ea.",
"submodule_paths": ["Deserunt omnis qui.",
"Officia quisquam repellat nam blanditiis.",
"Nam nobis ut."
]
}

Create module readme

Endpoint to push the Readme for a given module

Securityx-api-key

Request

path Parameters

name required	string module name Example: Deleniti expedita in reprehenderit quas.
system required	string system name Example: Animi rerum sint.
version required	string version of the module Example: Ut quia facere.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Dicta voluptatem.

header Parameters

Harness-Account required	string account name Example: Dolorum sint aut laudantium.
Content-Length	integer <int64> Size in bytes of the readme Example: 2201822058248807700

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: 0

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": {"Commodi deserunt exercitationem ipsa nesciunt illum provident.": "Ipsam ratione mollitia voluptate molestiae necessitatibus et.",
"Cumque corporis voluptate.": "Repudiandae eaque dolores."
},
"tags": ["Molestiae possimus.",
"Vero dolore consequatur.",
"Vel vel totam amet odio quis exercitationem.",
"Aut fugit ut consectetur modi velit."
]
}

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=Aspernatur animi rerum animi modi exercitationem et.
project	string project name Example: project=Deserunt itaque aut voluptate impedit.

header Parameters

Harness-Account

required

string

account name

Example: Sint neque laborum animi 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/connectors

Request samples

curl
Java
Go

Response samples

application/json

["Sequi minus libero.",
"Quo deserunt molestias sunt.",
"At officia repellendus ut unde laudantium aut.",
"Et eaque."
]

Download module

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Animi porro omnis laborum ducimus facilis voluptatem.
name required	string module name Example: Vero ab non sit similique architecto corporis.
system required	string system name Example: Illum et nam expedita natus.
version required	string version of the module Example: Dolor sapiente impedit.

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: Dolor mollitia.
name required	string module name Example: Omnis et ipsa.
system required	string system name Example: Quidem expedita mollitia.

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": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
},
{"git_version": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
}
]
},
{"versions": [{"git_version": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
},
{"git_version": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
}
]
},
{"versions": [{"git_version": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
},
{"git_version": "Ea non eligendi dolores.",
"module_version": "Iure voluptatibus."
}
]
}
]
}

➔ 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

query Parameters

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