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: Et enim eligendi illo ipsam.

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": "grs",
"created": 2771718328132106000,
"description": "Sunt vel est.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Qui esse qui omnis.",
"name": "ljs",
"repository": "Rem deleniti repellat atque enim voluptas earum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Saepe molestias.",
"repository_path": "",
"repository_url": "Non omnis iusto perspiciatis occaecati iste.",
"synced": 4758614571764785000,
"system": "mf",
"tags": "Nihil aut.",
"testing_enabled": true,
"testing_metadata": {"account": "r",
"org": "x",
"pipelines": ["Quia iste nobis dolor eligendi mollitia.",
"Odio ipsam laborum.",
"Aspernatur quia corrupti vel accusantium eos voluptas.",
"Quia quae blanditiis nisi."
],
"project": "qv",
"provider_connector": "Et qui fugiat.",
"provisioner_type": "Tempore illo saepe voluptas.",
"provisioner_version": "Aut alias qui consectetur.",
"release_pipeline": "Dolores nam consequatur cum totam."
},
"updated": 1501293329391327200,
"versions": ["Qui sed quibusdam id nostrum.",
"Est deleniti.",
"Aut quibusdam omnis ullam quod eaque.",
"Incidunt eum qui odio eligendi hic dolores."
]
},
{"account": "grs",
"created": 2771718328132106000,
"description": "Sunt vel est.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Qui esse qui omnis.",
"name": "ljs",
"repository": "Rem deleniti repellat atque enim voluptas earum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Saepe molestias.",
"repository_path": "",
"repository_url": "Non omnis iusto perspiciatis occaecati iste.",
"synced": 4758614571764785000,
"system": "mf",
"tags": "Nihil aut.",
"testing_enabled": true,
"testing_metadata": {"account": "r",
"org": "x",
"pipelines": ["Quia iste nobis dolor eligendi mollitia.",
"Odio ipsam laborum.",
"Aspernatur quia corrupti vel accusantium eos voluptas.",
"Quia quae blanditiis nisi."
],
"project": "qv",
"provider_connector": "Et qui fugiat.",
"provisioner_type": "Tempore illo saepe voluptas.",
"provisioner_version": "Aut alias qui consectetur.",
"release_pipeline": "Dolores nam consequatur cum totam."
},
"updated": 1501293329391327200,
"versions": ["Qui sed quibusdam id nostrum.",
"Est deleniti.",
"Aut quibusdam omnis ullam quod eaque.",
"Incidunt eum qui odio eligendi hic dolores."
]
},
{"account": "grs",
"created": 2771718328132106000,
"description": "Sunt vel est.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Qui esse qui omnis.",
"name": "ljs",
"repository": "Rem deleniti repellat atque enim voluptas earum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Saepe molestias.",
"repository_path": "",
"repository_url": "Non omnis iusto perspiciatis occaecati iste.",
"synced": 4758614571764785000,
"system": "mf",
"tags": "Nihil aut.",
"testing_enabled": true,
"testing_metadata": {"account": "r",
"org": "x",
"pipelines": ["Quia iste nobis dolor eligendi mollitia.",
"Odio ipsam laborum.",
"Aspernatur quia corrupti vel accusantium eos voluptas.",
"Quia quae blanditiis nisi."
],
"project": "qv",
"provider_connector": "Et qui fugiat.",
"provisioner_type": "Tempore illo saepe voluptas.",
"provisioner_version": "Aut alias qui consectetur.",
"release_pipeline": "Dolores nam consequatur cum totam."
},
"updated": 1501293329391327200,
"versions": ["Qui sed quibusdam id nostrum.",
"Est deleniti.",
"Aut quibusdam omnis ullam quod eaque.",
"Incidunt eum qui odio eligendi hic dolores."
]
}
]

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

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": "Tempora porro tenetur earum dolor aut.",
"git_tag_style": "Et eum.",
"name": "a43",
"org": "l0c",
"project": "ao8",
"repository": "Atque molestiae vero iste.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Mollitia dolorem reprehenderit esse maxime est.",
"repository_path": "",
"system": "uoy",
"tags": "Aperiam cum dolorum molestiae et sed."
}

Response samples

application/json

{"account": "k",
"created": 2893139918729080300,
"description": "Consequatur sed repellendus cupiditate enim.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "fq",
"repository": "Placeat eum nihil quasi cupiditate ducimus at.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Non aut sit.",
"repository_path": "",
"system": "5",
"tags": "Provident esse distinctio dicta cumque.",
"updated": 128654031569769420
}

Delete module

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Eos voluptas.

header Parameters

Harness-Account

required

string

account name

Example: Voluptas voluptas est.

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: Omnis dicta et minima quaerat excepturi.

header Parameters

Harness-Account

required

string

account name

Example: Dicta et tempora quisquam voluptates 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": "n",
"created": 8628888575541807000,
"description": "Iste vel vel id voluptatem.",
"git_tag_style": "Quas nihil nihil aut sequi quod eius.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Molestiae necessitatibus voluptates omnis voluptatibus ut.",
"name": "a",
"org": "r8u",
"project": "x",
"repository": "Est omnis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Assumenda commodi commodi voluptatem magni.",
"repository_path": "",
"repository_url": "Quis consequatur quo molestias et placeat esse.",
"synced": 3980191978657367000,
"system": "a6u",
"tags": "Aut alias mollitia repellat et nisi.",
"testing_enabled": true,
"testing_metadata": {"account": "s",
"org": "4",
"pipelines": ["Autem beatae sit ratione odio.",
"Provident voluptatem iure ratione.",
"Cumque eos quaerat quos est.",
"In qui non unde aperiam amet in."
],
"project": "q0o",
"provider_connector": "Pariatur sunt nulla.",
"provisioner_type": "Est quisquam autem.",
"provisioner_version": "Nemo voluptatem sapiente nisi quae vitae facilis.",
"release_pipeline": "Ipsa perspiciatis est."
},
"updated": 6069250488747483000,
"versions": ["Nostrum non ullam.",
"Omnis sunt quas cum sed nostrum.",
"Quaerat voluptatem et dolor."
]
}

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

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": "Fugiat dolores ducimus.",
"git_tag_style": "Consequatur ut sit sit necessitatibus explicabo.",
"name": "nyj",
"org": "hp",
"project": "p9",
"repository": "Libero qui aut ut iste quibusdam.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nostrum dicta minus ex magnam.",
"repository_path": "",
"system": "ef0",
"tags": "Ut eveniet id aperiam."
}

Create testing pipeline

Create a new testing pipeline for a given module

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Aut inventore et.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: ydu

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": "o",
"project": "o43"
}

Sync module metadata

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Dolores totam.

header Parameters

Harness-Account

required

string

account name

Example: Voluptatibus aut.

Responses

204

No Content response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

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

header Parameters

Harness-Account

required

string

account name

Example: Quo officia in non.

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: Voluptatum corrupti dolore exercitationem.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e

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": "p4",
"pipeline_id": ["Et tempora commodi eius vero.",
"Quod qui ad illo ut."
],
"project": "wb",
"provider_connector": "Consequatur nisi nobis.",
"provisioner_type": "Id quis laboriosam porro.",
"provisioner_version": "Suscipit praesentium nesciunt tempore facilis.",
"release_pipeline": "Quisquam odio consequatur consectetur non."
}

Update module testing

Update module testing metadata

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Perspiciatis libero voluptatem iure possimus.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: e

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": "ic8",
"pipeline_id": ["Rerum dolorum qui.",
"Facilis corporis cum ipsam sequi aut.",
"Quo vel aut quis dolorum."
],
"project": "vwk",
"provider_connector": "Quos id consequatur corporis.",
"provisioner_type": "Nostrum ut ut esse excepturi quos dolore.",
"provisioner_version": "Iusto qui consequuntur iure maxime vel.",
"release_pipeline": "Neque dolore quod accusantium."
}

List module metadata

List the module metadata from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Et minima sit a blanditiis.

query Parameters

version required	string version of the module Example: version=Dolore maiores sit quidem quo.
submodule	string submodule name Example: submodule=Veritatis non consequatur.

header Parameters

Harness-Account

required

string

account name

Example: Magnam voluptatem quisquam consequuntur ex corporis et.

Responses

200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/modules/{module_id}/metadata

Request samples

curl
Java
Go

Response samples

application/json

{"account": "Ipsa ipsam in fuga facere numquam.",
"dependencies": [{"dependency_name": "Consequuntur ipsam.",
"dependency_source": "Aliquam doloremque ea quasi a.",
"dependency_version": "Voluptatem aliquam est nobis laudantium id."
},
{"dependency_name": "Consequuntur ipsam.",
"dependency_source": "Aliquam doloremque ea quasi a.",
"dependency_version": "Voluptatem aliquam est nobis laudantium id."
},
{"dependency_name": "Consequuntur ipsam.",
"dependency_source": "Aliquam doloremque ea quasi a.",
"dependency_version": "Voluptatem aliquam est nobis laudantium id."
},
{"dependency_name": "Consequuntur ipsam.",
"dependency_source": "Aliquam doloremque ea quasi a.",
"dependency_version": "Voluptatem aliquam est nobis laudantium id."
}
],
"metadata_error": "At deserunt.",
"module_version": "Odio ea reprehenderit recusandae magni et sapiente.",
"name": "Vero esse ipsum repellendus nulla et nesciunt.",
"outputs": [{"output_description": "Consequatur et ipsa reprehenderit dolorem sit.",
"output_name": "Fugit perferendis asperiores architecto a quidem debitis.",
"output_sensitive": true
},
{"output_description": "Consequatur et ipsa reprehenderit dolorem sit.",
"output_name": "Fugit perferendis asperiores architecto a quidem debitis.",
"output_sensitive": true
},
{"output_description": "Consequatur et ipsa reprehenderit dolorem sit.",
"output_name": "Fugit perferendis asperiores architecto a quidem debitis.",
"output_sensitive": true
},
{"output_description": "Consequatur et ipsa reprehenderit dolorem sit.",
"output_name": "Fugit perferendis asperiores architecto a quidem debitis.",
"output_sensitive": true
}
],
"providers": [{"provider_name": "Aut doloribus fuga quasi dolores iure.",
"provider_source": "Neque asperiores quo aliquid.",
"provider_version": "Quod assumenda molestias aut."
},
{"provider_name": "Aut doloribus fuga quasi dolores iure.",
"provider_source": "Neque asperiores quo aliquid.",
"provider_version": "Quod assumenda molestias aut."
}
],
"resources": [{"resource_name": "Aut eum.",
"resource_type": "Ipsum voluptates quia sed qui optio."
},
{"resource_name": "Aut eum.",
"resource_type": "Ipsum voluptates quia sed qui optio."
}
],
"submodule": ["Possimus consequatur omnis sed in.",
"Amet consequatur.",
"Molestias error excepturi laudantium dignissimos."
],
"system": "Facilis cum.",
"variables": [{"variable_default": "Nihil rerum debitis vel iure adipisci similique.",
"variable_description": "Voluptatibus ullam aut iusto.",
"variable_name": "Sit et temporibus autem voluptatibus eveniet.",
"variable_required": false,
"variable_sensitive": true,
"variable_type": "Facere cupiditate."
},
{"variable_default": "Nihil rerum debitis vel iure adipisci similique.",
"variable_description": "Voluptatibus ullam aut iusto.",
"variable_name": "Sit et temporibus autem voluptatibus eveniet.",
"variable_required": false,
"variable_sensitive": true,
"variable_type": "Facere cupiditate."
},
{"variable_default": "Nihil rerum debitis vel iure adipisci similique.",
"variable_description": "Voluptatibus ullam aut iusto.",
"variable_name": "Sit et temporibus autem voluptatibus eveniet.",
"variable_required": false,
"variable_sensitive": true,
"variable_type": "Facere cupiditate."
},
{"variable_default": "Nihil rerum debitis vel iure adipisci similique.",
"variable_description": "Voluptatibus ullam aut iusto.",
"variable_name": "Sit et temporibus autem voluptatibus eveniet.",
"variable_required": false,
"variable_sensitive": true,
"variable_type": "Facere cupiditate."
}
]
}

List module readme

List the module readme from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Saepe et ut minus enim repellendus.

query Parameters

version required	string version of the module Example: version=Amet vel quae.
submodule	string submodule name Example: submodule=Repellat consequatur vel qui non et.

header Parameters

Harness-Account

required

string

account name

Example: Voluptas doloribus sapiente.

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

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": "ndo",
"eventType": "Sit autem.",
"metadata": {"pipeline": "Eius nemo tempora quo.",
"pipeline_execution_id": "Recusandae atque eum repellat consequatur accusamus deleniti.",
"pipeline_execution_number": "Atque earum voluptatum.",
"pipeline_name": "Magni excepturi eos quo provident.",
"pipeline_stage_id": "Cumque laudantium et ea aut.",
"trigger": {"Illum vel optio sit id.": "Et nemo in.",
"Ut et.": "Fuga in et sit ut id."
}
},
"org": "06k",
"project": "i5"
}

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: Aperiam exercitationem dolorem accusantium laboriosam.

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=Cumque similique.
status	Array of strings Status of the execution Example: status=Soluta natus molestias ut accusantium ipsa.&status=Placeat quasi necessitatibus eos culpa.&status=Enim optio commodi odio facilis.
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: 5d

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": "p",
"created": 7292717116780788000,
"metadata": {"pipeline": "Fuga aut.",
"pipeline_execution_id": "Quasi voluptate.",
"pipeline_execution_number": "Quidem est impedit alias aut eaque.",
"pipeline_name": "Corrupti dignissimos magnam rerum.",
"pipeline_stage_id": "Quos eum sunt eum.",
"trigger": {"Dolores tempora maxime.": "Quo voluptas.",
"Perspiciatis neque.": "Totam quae iste ab."
}
},
"moduleId": "Modi atque cum a.",
"org": "5q",
"project": "ax2",
"status": "Qui numquam."
},
{"account": "p",
"created": 7292717116780788000,
"metadata": {"pipeline": "Fuga aut.",
"pipeline_execution_id": "Quasi voluptate.",
"pipeline_execution_number": "Quidem est impedit alias aut eaque.",
"pipeline_name": "Corrupti dignissimos magnam rerum.",
"pipeline_stage_id": "Quos eum sunt eum.",
"trigger": {"Dolores tempora maxime.": "Quo voluptas.",
"Perspiciatis neque.": "Totam quae iste ab."
}
},
"moduleId": "Modi atque cum a.",
"org": "5q",
"project": "ax2",
"status": "Qui numquam."
},
{"account": "p",
"created": 7292717116780788000,
"metadata": {"pipeline": "Fuga aut.",
"pipeline_execution_id": "Quasi voluptate.",
"pipeline_execution_number": "Quidem est impedit alias aut eaque.",
"pipeline_name": "Corrupti dignissimos magnam rerum.",
"pipeline_stage_id": "Quos eum sunt eum.",
"trigger": {"Dolores tempora maxime.": "Quo voluptas.",
"Perspiciatis neque.": "Totam quae iste ab."
}
},
"moduleId": "Modi atque cum a.",
"org": "5q",
"project": "ax2",
"status": "Qui numquam."
}
]

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: Quisquam laboriosam at ab velit omnis.

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": "a6",
"org": "u",
"pipeline": "Dignissimos tempore ratione.",
"pipelineExecutionId": "Praesentium illum eius.",
"pipelineStageId": "Dolor exercitationem officiis.",
"project": "c"
}

Response samples

application/json

{"account": "n",
"created": 3965277890972858400,
"metadata": {"pipeline": "Sequi alias praesentium.",
"pipeline_execution_id": "Ad est vero.",
"pipeline_execution_number": "Necessitatibus qui eligendi aut sit cum praesentium.",
"pipeline_name": "Fugiat modi tenetur et deserunt qui ipsam.",
"pipeline_stage_id": "Aut earum et molestiae.",
"trigger": {"Nisi ad impedit officiis voluptas id.": "Recusandae et facere enim.",
"Quis ullam incidunt amet explicabo aut animi.": "Voluptatem est id aut hic doloremque illum.",
"Voluptate itaque iusto et eum.": "Laboriosam omnis esse delectus."
}
},
"moduleId": "Ad debitis alias amet tempore dolorum.",
"org": "m3",
"project": "11",
"status": "Perferendis est est sint dolor."
}

Create module data

Create a new module in the module registry

Securityx-api-key

Request

path Parameters

name required	string module name Example: Ut fugiat magni repellendus non blanditiis.
system required	string system name Example: Aliquid mollitia autem dolores perferendis enim.
version required	string version of the module Example: Maxime maiores aut eum dolor.

header Parameters

Harness-Account

required

string

account name

Example: Repudiandae ea occaecati nobis facere.

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": "Cupiditate ipsum eos amet corrupti rerum.",
"error": {"A excepturi.": "Molestiae officiis magni odit sed nihil explicabo.",
"Eveniet perspiciatis quia fugiat omnis reprehenderit error.": "Dolorem reprehenderit aut facere aut voluptas."
},
"examples_paths": ["Quidem est recusandae necessitatibus.",
"Sit dolorem commodi nisi totam atque hic.",
"Alias reprehenderit consequatur quidem aut aliquid expedita.",
"Fugiat tempora vel sit similique ex."
],
"git_tag": "Ipsum autem delectus veritatis sunt perspiciatis ab.",
"metadata": "Sunt est corrupti et nihil.",
"repo_url": "Excepturi ea nulla.",
"submodule_name": "Sunt consequatur mollitia consequatur magnam eaque dolores.",
"submodule_paths": ["Quis rem.",
"Quas temporibus nemo.",
"Modi quia qui quibusdam."
]
}

Create module readme

Endpoint to push the Readme for a given module

Securityx-api-key

Request

path Parameters

name required	string module name Example: Aut amet aliquid adipisci architecto quam esse.
system required	string system name Example: Ut qui ut eveniet molestiae.
version required	string version of the module Example: Reiciendis et.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Dolor soluta porro vero unde aperiam.

header Parameters

Harness-Account required	string account name Example: Enim quo sit dolores rerum commodi sunt.
Content-Length	integer <int64> Size in bytes of the readme Example: 1248628763415340800

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: l

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": {"Rem porro quo voluptatem.": "Dolore consequuntur dolores architecto autem autem ea.",
"Temporibus et sint fugiat ad fugit doloremque.": "Magnam ab.",
"Veritatis ut rerum modi minima.": "Error et aut culpa temporibus optio corporis."
},
"tags": ["Consequuntur ut dolor eos deleniti et.",
"Facere reprehenderit tempore impedit suscipit."
]
}

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

["Id ut.",
"Voluptate qui porro occaecati placeat."
]

Download module

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Libero aperiam ea non expedita omnis rerum.
name required	string module name Example: Officiis autem ea velit qui in provident.
system required	string system name Example: Ut distinctio sit saepe.
version required	string version of the module Example: Consequuntur voluptatem qui eos recusandae sequi.

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: Iure consequatur.
name required	string module name Example: Culpa qui voluptatibus et.
system required	string system name Example: Et ratione quo sunt est.

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": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
}
]
},
{"versions": [{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
}
]
},
{"versions": [{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
}
]
},
{"versions": [{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
},
{"git_version": "Aperiam quidem exercitationem inventore voluptas aut officia.",
"module_version": "Voluptatem libero quam quis maiores."
}
]
}
]
}

➔ 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