module-registry

The module-registry service is a private registry for Terraform/Opentofu modules

List modules

List all modules from the module registry

Securityx-api-key

Request

query Parameters

limit	integer <int64> [ 1 .. 1000 ] Default: 30 Limit is the number of records to return for a page. Example: limit=30
page	integer <int64> >= 1 Default: 1 Page is the page number to return relative to the page 'limit'. Example: page=1
searchTerm	string Default: "" Filter results by partial name match Example: searchTerm=mymod
sort	string Default: "name,ASC" Sort order for results Enum: "name,ASC" "name,DESC" "updated,ASC" "updated,DESC" Example: sort=name,ASC

header Parameters

Harness-Account

required

string

account name

Example: Officiis voluptate sit quaerat eum non aut.

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": "j5",
"created": 1638376206731514000,
"description": "Quae atque blanditiis labore vel recusandae rerum.",
"git_tag_style": "Quisquam quisquam.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Labore harum quaerat vel.",
"name": "7",
"org": "gif",
"project": "bk",
"repository": "Aut illum eum provident.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Occaecati possimus sit adipisci.",
"repository_path": "",
"repository_url": "Sit facilis veniam.",
"synced": 600427171558809300,
"system": "z",
"tags": "Ut similique itaque corporis.",
"testing_enabled": true,
"testing_metadata": {"account": "a",
"org": "g",
"pipelines": ["Quia qui voluptate qui.",
"Nihil voluptate vel."
],
"project": "12o",
"provider_connector": "Recusandae repellat.",
"provisioner_type": "Consequatur quidem corporis dolore debitis consequuntur.",
"provisioner_version": "Omnis vitae.",
"release_pipeline": "Dolorum alias occaecati dolor."
},
"updated": 6141623224221170000,
"versions": ["Vero quod natus hic nesciunt est facere.",
"At deleniti id tempore laboriosam nobis."
]
},
{"account": "j5",
"created": 1638376206731514000,
"description": "Quae atque blanditiis labore vel recusandae rerum.",
"git_tag_style": "Quisquam quisquam.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "Labore harum quaerat vel.",
"name": "7",
"org": "gif",
"project": "bk",
"repository": "Aut illum eum provident.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Occaecati possimus sit adipisci.",
"repository_path": "",
"repository_url": "Sit facilis veniam.",
"synced": 600427171558809300,
"system": "z",
"tags": "Ut similique itaque corporis.",
"testing_enabled": true,
"testing_metadata": {"account": "a",
"org": "g",
"pipelines": ["Quia qui voluptate qui.",
"Nihil voluptate vel."
],
"project": "12o",
"provider_connector": "Recusandae repellat.",
"provisioner_type": "Consequatur quidem corporis dolore debitis consequuntur.",
"provisioner_version": "Omnis vitae.",
"release_pipeline": "Dolorum alias occaecati dolor."
},
"updated": 6141623224221170000,
"versions": ["Vero quod natus hic nesciunt est facere.",
"At deleniti id tempore laboriosam nobis."
]
}
]

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

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": "Sed excepturi enim consectetur totam voluptatem consequatur.",
"git_tag_style": "Quia a sunt reprehenderit corporis tempora.",
"name": "c",
"org": "8cz",
"project": "vem",
"repository": "Eligendi voluptas veritatis.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Nihil facilis.",
"repository_path": "",
"system": "n7",
"tags": "Cupiditate eum non nemo illum suscipit."
}

Response samples

application/json

{"account": "p",
"created": 6027053855075909000,
"description": "Mollitia nam nobis ut accusantium reiciendis maxime.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"name": "t",
"repository": "Aspernatur debitis neque nostrum.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Possimus ullam aliquid officia et.",
"repository_path": "",
"system": "da",
"tags": "Voluptatem ea culpa explicabo voluptas necessitatibus libero.",
"updated": 6515491883336398000
}

Delete module

Delete a module from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Ipsa quis deleniti quis nam quas.

header Parameters

Harness-Account

required

string

account name

Example: Blanditiis rerum nostrum perferendis sit eligendi.

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: Eaque aut ullam architecto.

header Parameters

Harness-Account

required

string

account name

Example: Laborum dolore laboriosam.

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": "6ae",
"created": 4959919360173217000,
"description": "Atque eveniet et laboriosam.",
"git_tag_style": "Magni distinctio consequatur.",
"id": "aaaaaaaa-bbbb-cccc-eeee-ffffffffffff",
"module_error": "In consequatur tempora voluptate id.",
"name": "81t",
"org": "2uj",
"project": "6bi",
"repository": "Non temporibus.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Maxime aut incidunt saepe.",
"repository_path": "",
"repository_url": "Quo at molestiae omnis aut natus et.",
"synced": 3494944466502276600,
"system": "1ag",
"tags": "Quibusdam explicabo incidunt error rem consequuntur.",
"testing_enabled": true,
"testing_metadata": {"account": "v1",
"org": "z5",
"pipelines": ["Et libero qui provident aut aut.",
"Corrupti adipisci culpa eum ea voluptates quia.",
"Odit quis eum.",
"Est nostrum placeat aliquid."
],
"project": "7f",
"provider_connector": "Perferendis quasi sit.",
"provisioner_type": "Consequatur corporis cum perferendis illum architecto repudiandae.",
"provisioner_version": "Provident suscipit soluta hic occaecati.",
"release_pipeline": "Laborum nobis et natus assumenda aliquam delectus."
},
"updated": 7270161281151363000,
"versions": ["Qui et repellendus possimus est odit nulla.",
"Aut est praesentium doloremque minus.",
"Voluptates at in.",
"Earum est quia ut sunt provident accusamus."
]
}

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

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": "Dolore consequatur maiores vel vel.",
"git_tag_style": "Impedit ipsam.",
"name": "xel",
"org": "c6",
"project": "jti",
"repository": "Amet odio quis exercitationem illo aut fugit.",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "Consectetur modi velit unde.",
"repository_path": "",
"system": "12p",
"tags": "Reiciendis molestiae possimus reprehenderit."
}

Create testing pipeline

Create a new testing pipeline for a given module

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Porro doloremque voluptatem dolorem sed est voluptatem.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: g1

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": "1d",
"project": "pg"
}

Sync module metadata

Sync the module metadata from the module registry

Securityx-api-key

Request

path Parameters

required

string

Example: Eos et perferendis ut iure.

header Parameters

Harness-Account

required

string

account name

Example: Id exercitationem accusantium 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.

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

header Parameters

Harness-Account

required

string

account name

Example: Quam 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.

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: Quos aliquam maxime repellat vero quam.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: 4g

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": "d",
"pipeline_id": ["Quaerat accusamus consequuntur molestias consequatur ut.",
"Laborum earum sunt qui sit et.",
"Est possimus dolor hic iste.",
"Iure cumque illum cum libero dolorum."
],
"project": "c",
"provider_connector": "Sapiente accusamus.",
"provisioner_type": "Molestiae perspiciatis eum esse ut est.",
"provisioner_version": "Ea mollitia.",
"release_pipeline": "Corporis ut nisi repellendus debitis."
}

Update module testing

Update module testing metadata

Securityx-api-key

Request

path Parameters

required

string

module id

Example: Deleniti ut eum quaerat eius.

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

Account is the internal customer account ID.

Example: u

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": "9j",
"pipeline_id": ["Vitae eos repellat voluptates eos ut voluptatem.",
"Qui magnam et ad fugit.",
"Amet magni."
],
"project": "oc",
"provider_connector": "Et expedita assumenda libero fuga perferendis dolores.",
"provisioner_type": "Modi et dolores in ullam est laudantium.",
"provisioner_version": "Ut error aspernatur minus deleniti et quasi.",
"release_pipeline": "Ea et."
}

List module metadata

List the module metadata from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Magnam dolorum.

query Parameters

version required	string version of the module Example: version=Totam rerum hic aut.
submodule	string submodule name Example: submodule=Aspernatur deserunt enim excepturi.

header Parameters

Harness-Account

required

string

account name

Example: Repellat consequatur 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": "Alias ipsum sint consequuntur.",
"dependencies": [{"dependency_name": "Eligendi explicabo.",
"dependency_source": "Totam aut aut.",
"dependency_version": "Harum ea id tempore repudiandae."
},
{"dependency_name": "Eligendi explicabo.",
"dependency_source": "Totam aut aut.",
"dependency_version": "Harum ea id tempore repudiandae."
}
],
"metadata_error": "Nihil non porro deleniti voluptatibus tenetur omnis.",
"module_version": "Asperiores voluptates corrupti.",
"name": "Quia assumenda non quam.",
"outputs": [{"output_description": "Qui aut illo omnis quibusdam.",
"output_name": "Esse dolor eligendi reprehenderit.",
"output_sensitive": true
},
{"output_description": "Qui aut illo omnis quibusdam.",
"output_name": "Esse dolor eligendi reprehenderit.",
"output_sensitive": true
},
{"output_description": "Qui aut illo omnis quibusdam.",
"output_name": "Esse dolor eligendi reprehenderit.",
"output_sensitive": true
},
{"output_description": "Qui aut illo omnis quibusdam.",
"output_name": "Esse dolor eligendi reprehenderit.",
"output_sensitive": true
}
],
"providers": [{"provider_name": "Eligendi unde quaerat.",
"provider_source": "Vel aspernatur tempora.",
"provider_version": "Omnis blanditiis explicabo voluptates totam fugit a."
},
{"provider_name": "Eligendi unde quaerat.",
"provider_source": "Vel aspernatur tempora.",
"provider_version": "Omnis blanditiis explicabo voluptates totam fugit a."
}
],
"resources": [{"resource_name": "Aut incidunt maiores quam.",
"resource_type": "Et doloribus ullam."
},
{"resource_name": "Aut incidunt maiores quam.",
"resource_type": "Et doloribus ullam."
},
{"resource_name": "Aut incidunt maiores quam.",
"resource_type": "Et doloribus ullam."
}
],
"submodule": ["Velit et sit in.",
"Quisquam dolores."
],
"system": "Nisi aut.",
"variables": [{"variable_default": "Totam quasi quos neque vitae.",
"variable_description": "Repudiandae perferendis.",
"variable_name": "Repellat dolores beatae aut et.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "At illo velit quibusdam velit."
},
{"variable_default": "Totam quasi quos neque vitae.",
"variable_description": "Repudiandae perferendis.",
"variable_name": "Repellat dolores beatae aut et.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "At illo velit quibusdam velit."
},
{"variable_default": "Totam quasi quos neque vitae.",
"variable_description": "Repudiandae perferendis.",
"variable_name": "Repellat dolores beatae aut et.",
"variable_required": true,
"variable_sensitive": true,
"variable_type": "At illo velit quibusdam velit."
}
]
}

List module readme

List the module readme from the module registry

Securityx-api-key

Request

path Parameters

module_id

required

string

module id

Example: Quam et quos quo occaecati tempora ipsam.

query Parameters

version required	string version of the module Example: version=Ipsam eaque adipisci magnam.
submodule	string submodule name Example: submodule=Maiores tempora.

header Parameters

Harness-Account

required

string

account name

Example: Ea molestias dolor.

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

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": "j",
"eventType": "Doloribus corrupti et amet.",
"metadata": {"pipeline": "Excepturi voluptate suscipit neque aliquid quam voluptas.",
"pipeline_execution_id": "Ut pariatur adipisci veniam et enim voluptate.",
"pipeline_execution_number": "Atque similique atque tempore porro error veritatis.",
"pipeline_name": "Voluptas neque.",
"pipeline_stage_id": "Sunt ipsam placeat quis nesciunt adipisci voluptatibus.",
"trigger": {"Molestiae totam animi excepturi ducimus.": "Molestias eveniet."
}
},
"org": "bo0",
"project": "0"
}

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: Numquam sequi eaque commodi ad animi.

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=At odit.
status	Array of strings Status of the execution Example: status=Autem sapiente quod eum.&status=Qui est quo odit a quibusdam voluptas.&status=Consequatur quaerat rem earum ipsam nihil sit.&status=Beatae quas voluptas sint repellendus vel.
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: qq

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": "4gv",
"created": 828382518958007400,
"metadata": {"pipeline": "Doloremque repellat qui facere quas.",
"pipeline_execution_id": "Aliquam incidunt aliquam non ducimus consequatur sunt.",
"pipeline_execution_number": "Quas autem et maiores qui nemo.",
"pipeline_name": "Necessitatibus distinctio delectus.",
"pipeline_stage_id": "Consequatur doloribus.",
"trigger": {"Enim et nobis quos ipsa.": "Et fugit.",
"Exercitationem esse necessitatibus dolore.": "Est non placeat sunt rerum dicta delectus.",
"Reprehenderit quod.": "Voluptates doloribus."
}
},
"moduleId": "Omnis et quas voluptatem consectetur qui quod.",
"org": "d2",
"project": "8m",
"status": "Assumenda dolore eum."
},
{"account": "4gv",
"created": 828382518958007400,
"metadata": {"pipeline": "Doloremque repellat qui facere quas.",
"pipeline_execution_id": "Aliquam incidunt aliquam non ducimus consequatur sunt.",
"pipeline_execution_number": "Quas autem et maiores qui nemo.",
"pipeline_name": "Necessitatibus distinctio delectus.",
"pipeline_stage_id": "Consequatur doloribus.",
"trigger": {"Enim et nobis quos ipsa.": "Et fugit.",
"Exercitationem esse necessitatibus dolore.": "Est non placeat sunt rerum dicta delectus.",
"Reprehenderit quod.": "Voluptates doloribus."
}
},
"moduleId": "Omnis et quas voluptatem consectetur qui quod.",
"org": "d2",
"project": "8m",
"status": "Assumenda dolore eum."
}
]

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: Laborum et.

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": "h",
"org": "u",
"pipeline": "Et veniam.",
"pipelineExecutionId": "Dolorum quas pariatur omnis id.",
"pipelineStageId": "Voluptatem voluptas non ut et.",
"project": "gu"
}

Response samples

application/json

{"account": "o0",
"created": 6847675995672482000,
"metadata": {"pipeline": "Et minus minus.",
"pipeline_execution_id": "Perferendis ipsa libero aperiam quasi porro.",
"pipeline_execution_number": "Corrupti quod non ipsam corporis.",
"pipeline_name": "Quasi pariatur dolores.",
"pipeline_stage_id": "Harum fuga.",
"trigger": {"Distinctio repudiandae rerum dolorem eaque nihil voluptatibus.": "Dolore quae qui voluptatem nesciunt pariatur et.",
"Quisquam et veritatis consequatur non.": "Qui dignissimos molestiae repudiandae nihil voluptatem."
}
},
"moduleId": "Est ut animi dolor maxime aut quas.",
"org": "e",
"project": "w",
"status": "Reprehenderit sint necessitatibus."
}

Create module data

Create a new module in the module registry

Securityx-api-key

Request

path Parameters

name required	string module name Example: Ut vel.
system required	string system name Example: Asperiores deleniti id mollitia harum repellat illum.
version required	string version of the module Example: Explicabo saepe accusamus.

header Parameters

Harness-Account

required

string

account name

Example: Velit voluptas nostrum.

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": "Ut deleniti.",
"error": {"Consectetur et voluptas reiciendis non veniam.": "Sequi aut.",
"Laudantium laudantium nesciunt blanditiis ut quasi aut.": "Libero quo.",
"Omnis quo ullam deserunt laudantium.": "Dignissimos laboriosam repudiandae molestiae id reiciendis."
},
"examples_paths": ["Qui voluptatibus autem quia.",
"Voluptate dignissimos repellendus.",
"Ratione libero cum ab."
],
"git_tag": "Sapiente dolor commodi nesciunt aut modi quo.",
"metadata": "Quidem dolor et aut qui.",
"repo_url": "Rerum voluptas.",
"submodule_name": "Quas sed non accusantium.",
"submodule_paths": ["Possimus tempora veniam ea.",
"Omnis suscipit reiciendis eos nihil alias eligendi.",
"Quos et accusantium voluptas beatae similique.",
"Dignissimos numquam voluptate."
]
}

Create module readme

Endpoint to push the Readme for a given module

Securityx-api-key

Request

path Parameters

name required	string module name Example: Dolore alias voluptas quos quo aperiam.
system required	string system name Example: Sed dolorem.
version required	string version of the module Example: Omnis quisquam corporis ut soluta et.

query Parameters

submoduleName

string

submodule name

Example: submoduleName=Maxime esse quaerat aperiam dolorem.

header Parameters

Harness-Account required	string account name Example: Sunt accusantium.
Content-Length	integer <int64> Size in bytes of the readme Example: 1911301708243888600

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

header Parameters

Harness-Account

required

string [ 1 .. 128 ] characters

account that owns the module

Example: 44z

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": {"Repellendus aut nesciunt.": "Eaque sed dolore voluptatum."
},
"tags": ["Magnam doloribus a consequatur voluptatem sequi.",
"Quidem soluta tempore non.",
"Consequatur quia enim."
]
}

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=Qui veniam ullam.
project	string project name Example: project=Consequatur rem est ipsam rerum.

header Parameters

Harness-Account

required

string

account name

Example: Recusandae minima qui.

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

["Eaque enim quam similique.",
"Aut sapiente quia quia aperiam laborum."
]

Download module

Download a module given a specific version

Securityx-api-key

Request

path Parameters

account required	string account name Example: Natus sit eaque molestias rem.
name required	string module name Example: Libero odio inventore.
system required	string system name Example: Qui fuga amet.
version required	string version of the module Example: Repudiandae est debitis qui.

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: Aut assumenda in saepe non.
name required	string module name Example: Rerum sit distinctio ut.
system required	string system name Example: Quo nam possimus.

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": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
},
{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
}
]
},
{"versions": [{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
},
{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
}
]
},
{"versions": [{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
},
{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
}
]
},
{"versions": [{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
},
{"git_version": "Iure ea beatae.",
"module_version": "Nam ab consequatur."
}
]
}
]
}

➔ 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