openapi: 3.2.0 info: title: Harness Module Registry API version: '1.0' description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0. contact: name: API Support email: contact@harness.io url: https://harness.io/ x-logo: url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook altText: Harness termsOfService: https://harness.io/terms-of-use/ servers: - url: https://app.harness.io description: Harness host URL - url: https://{vanity} description: Vanity URL variables: vanity: default: app.harness.io security: - x-api-key: [] tags: - name: module-registry description: The module-registry service is a private registry for Terraform/Opentofu modules paths: /iacm/api/modules: get: tags: - module-registry summary: List modules description: List all modules from the module registry operationId: module-registry#list_modules-by-account parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: searchTerm in: query description: Filter results by partial name or provider match allowEmptyValue: true schema: type: string description: Filter results by partial name or provider match default: '' example: mymod example: mymod - name: sort in: query description: Sort order for results allowEmptyValue: true schema: type: string description: Sort order for results default: name,ASC example: updated,DESC enum: - name,ASC - name,DESC - updated,ASC - updated,DESC example: name,DESC - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Et ipsa. example: Atque quaerat. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Et cum numquam expedita veritatis perspiciatis. example: Aspernatur sint atque. - name: provider in: query description: Filter modules to these providers (module_system values). Repeatable query param. allowEmptyValue: true schema: type: array items: type: string example: Natus sed quas doloremque. description: Filter modules to these providers (module_system values). Repeatable query param. example: - terraform - tofu example: - terraform - tofu - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Consequatur exercitationem. example: Minus ipsam quaerat eaque est. responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ModuleResourceCollection' example: - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Create module description: Create a new module in the module registry operationId: module-registry#create-module parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleRequest' example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: artifact system: aws tags: Officia officia velit voluptatem soluta quaerat. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ModuleRegistryCreateModuleResponseBody' example: account: abc123DEFghiJKL created: 5459285281721391000 description: Provisions a VPC with public and private subnets. id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff name: my-vpc-module org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' scope_org: my_org scope_project: my_project storage_type: git_reference system: aws tags: Eius sed assumenda illum sint beatae provident. updated: 5355892478085344000 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}: delete: tags: - module-registry summary: Delete module description: Delete a module from the module registry operationId: module-registry#delete-module parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Vel quibusdam consequatur id sit alias. example: Magni nemo non incidunt quia omnis vitae. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Doloremque nostrum dolorum est ut in. example: Assumenda necessitatibus fugiat porro. - name: id in: path description: id required: true schema: type: string description: id example: Quae molestiae officiis officiis sunt. example: Reprehenderit praesentium. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Modi ut soluta. example: Laboriosam molestias neque. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - module-registry summary: List module by id description: List a module from the module registry by ID operationId: module-registry#list-modules-by-id parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Voluptates magnam dolorem delectus velit. example: Repellendus porro officia quia doloribus est. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Veritatis dolorem enim architecto iusto. example: Voluptatem quis molestiae voluptates rerum. - name: id in: path description: module id required: true schema: type: string description: module id example: Itaque atque ipsum. example: Dolores ratione distinctio. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Est eveniet doloremque consequatur sint placeat accusantium. example: Quia dolore. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleByIDResponse' example: account: abc123DEFghiJKL created: 7074782854274014000 description: Provisions a VPC with public and private subnets. domain_prefix: Quia assumenda non quam. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Et inventore mollitia fugiat expedita tempore mollitia. name: my-vpc-module namespace: Alias ipsum sint consequuntur. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true onboarding_pipeline_wh: webhook_abc123 org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et veniam consequatur totam. scope_org: my_org scope_project: my_project storage_type: git_reference synced: 3892658297188124700 system: aws tags: Eligendi ut dicta voluptatem tempore. testing_enabled: false testing_metadata: account: r org: y pipelines: - Eos ex voluptas consequatur asperiores fugit. - Molestiae dolorum rerum sed voluptatibus veniam fuga. - Assumenda magni qui vel eaque repellendus ducimus. project: h provider_connector: Quod est illo tempore dolores. provisioner_type: Pariatur velit quasi. provisioner_version: Dolorum non labore tenetur impedit doloribus. release_pipeline: Architecto odio iure eius. updated: 5254455737636099000 version_statuses: Aut quaerat asperiores.: Corrupti fuga explicabo. versions: - Voluptates aut sunt. - Quos voluptatem et doloribus minima laboriosam aperiam. - Quia et exercitationem alias sit velit mollitia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Update module description: Update a module in the module registry operationId: module-registry#update-module parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: id in: path description: module id required: true schema: type: string description: module id example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateModuleRequest' example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: git_reference system: aws tags: Vero quod natus hic nesciunt est facere. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/lifecycle: delete: tags: - module-registry summary: Delete module lifecycle rule description: Delete the lifecycle rule and all overrides for a module; all versions revert to supported operationId: module-registry#delete-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Voluptatem non laborum. example: Nulla quisquam eum labore. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Ut eveniet. example: Vel est ipsum perferendis natus quos. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Alias autem vitae porro quae. example: Rem quia pariatur id voluptate occaecati ipsam. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Vero eaque iure itaque qui magni. example: Porro inventore. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' get: tags: - module-registry summary: Get module lifecycle rule description: Get the lifecycle rule for a module operationId: module-registry#get-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Nostrum ut enim voluptate. example: Odio sint officia et. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Itaque velit quia. example: Repellendus magnam voluptatem aut voluptatibus. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Quidem maxime. example: Consequatur consequatur sit quo. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Aliquam incidunt at. example: Aut iusto et voluptatem. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetModuleLifecycleResponse' example: deprecated_action: no_action overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: warn supported_count: 3 warning_action: warn warning_count: 2 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Upsert module lifecycle rule description: Create or replace the lifecycle rule for a module, atomically replacing all overrides operationId: module-registry#put-module-lifecycle parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Illo ullam nemo ea. example: Sint voluptas. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Iure temporibus recusandae ea qui non. example: Vero autem est et eveniet ipsum quis. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Cupiditate rerum ut. example: A dicta quo sit accusantium omnis. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Omnis sunt adipisci omnis. example: Est quae alias est est est non. requestBody: description: Lifecycle rule with overrides required: true content: application/json: schema: $ref: '#/components/schemas/ModuleLifecycleRule' example: deprecated_action: warn overrides: - reason: 7hw tier: deprecated version: v2.1.0 - reason: 7hw tier: deprecated version: v2.1.0 - reason: 7hw tier: deprecated version: v2.1.0 supported_action: warn supported_count: 3 warning_action: no_action warning_count: 2 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/PutModuleLifecycleResponse' example: deprecated_action: fail overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: no_action supported_count: 3 warning_action: fail warning_count: 2 '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/lifecycle/versions/{version}: get: tags: - module-registry summary: Get module version lifecycle status description: Compute the lifecycle tier and enforcement action for a specific module version operationId: module-registry#get-module-lifecycle-version-status parameters: - name: scope_org in: query description: Org scope of the module allowEmptyValue: true schema: type: string description: Org scope of the module example: Culpa debitis corporis tempore ducimus corporis. example: Doloremque delectus necessitatibus deleniti quasi. - name: scope_project in: query description: Project scope of the module allowEmptyValue: true schema: type: string description: Project scope of the module example: Iste illum amet. example: Cupiditate iure maiores voluptatem saepe. - name: id in: path description: Module ID required: true schema: type: string description: Module ID example: Sed labore tenetur non officiis dolor ut. example: Autem consequatur. - name: version in: path description: Version to look up required: true schema: type: string description: Version to look up example: Repudiandae est expedita. example: Quia facere nulla error quia dignissimos. - name: Harness-Account in: header description: Account name allowEmptyValue: true required: true schema: type: string description: Account name example: Inventore earum distinctio. example: Ut molestiae qui ipsam assumenda. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetModuleLifecycleVersionStatusResponse' example: action: no_action minimum_supported_version: Non error dolorem rerum. tier: warning '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/pipeline: post: tags: - module-registry summary: Create testing pipeline description: Create a new testing pipeline for a given module operationId: module-registry#create-testing-pipelines parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Expedita tempora. example: Veniam aperiam praesentium et delectus nihil. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Pariatur molestiae rerum. example: Qui quis voluptas aliquid aliquam aut ut. - name: id in: path description: module id required: true schema: type: string description: module id example: Error cum. example: Impedit aut porro. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Voluptas cum aut. example: Eum et id. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTestingPipelineRequest' example: pipeline_org: Voluptatem earum possimus enim repellat. pipeline_project: Saepe aspernatur alias temporibus. type: Sed sed neque. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/sync: post: tags: - module-registry summary: Sync module metadata description: Sync the module metadata from the module registry operationId: module-registry#sync-module-metadata parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Quibusdam ipsum deleniti dolorum vel quia. example: Optio quia. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Exercitationem velit dignissimos ullam. example: Voluptates quia. - name: id in: path description: id required: true schema: type: string description: id example: Ut voluptas id ipsum quia minima. example: Repellat aut aut et vitae minima. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Quisquam voluptas possimus molestiae molestiae. example: Nesciunt qui qui nobis vel molestias. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/tags: get: tags: - module-registry summary: List module tags description: List the module tags from the module registry operationId: module-registry#list-module-tags-by-id parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Sint ea praesentium. example: Necessitatibus illo. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Debitis eius consequatur eligendi. example: Quo labore esse deserunt ea eum assumenda. - name: id in: path description: module id required: true schema: type: string description: module id example: Amet quas. example: Possimus eaque sit ut et aspernatur non. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Rerum tempore eius ut. example: Qui voluptas nobis laboriosam fugit aspernatur qui. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Quam rerum. example: - Nam fugit ut facere saepe pariatur eveniet. - Possimus mollitia pariatur est. - Atque molestiae. - Vero quo voluptatum. example: - Ut et vel consequatur et quae. - Accusantium rem recusandae quas et laudantium ab. - Ex nihil esse quos occaecati. - Atque vitae dolores et est dolor. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/testing: delete: tags: - module-registry summary: Disable testing description: Disable testing for a module operationId: module-registry#disable-testing parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Non consequatur nihil cumque reprehenderit optio amet. example: Nisi sit aut quod velit eum. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Praesentium tempore omnis ipsum iste. example: Qui voluptatem enim recusandae. - name: id in: path description: module id required: true schema: type: integer description: module id example: 4150810973825628000 format: int64 example: 4849135301420935000 - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Sed distinctio. example: Dolore cum aliquid minus fugiat inventore. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Enable testing description: Enable testing for a module operationId: module-registry#enable-testing parameters: - name: scope_org in: query description: module org allowEmptyValue: true schema: type: string description: module org example: Eveniet in totam. example: Consequatur qui nostrum aliquam ratione hic. - name: scope_project in: query description: module project allowEmptyValue: true schema: type: string description: module project example: Id exercitationem ab facilis. example: Odit qui provident similique. - name: id in: path description: module id required: true schema: type: string description: module id example: Quia ipsum in enim ipsam praesentium est. example: Error sed illum animi. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Libero pariatur dolorum. example: Dolorum recusandae. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableTestingRequest' example: pipeline_id: - Praesentium impedit. - Qui eligendi dolorem sunt. - Consequuntur ut. - Numquam in occaecati voluptatum numquam harum. pipeline_org: Iste sunt libero assumenda debitis eum debitis. pipeline_project: Aut sit. provider_connector: Quidem iure et inventore dolore aliquid nihil. provisioner_type: Ut quas. provisioner_version: Quasi eum quae. release_pipeline: Nostrum a ex enim. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' put: tags: - module-registry summary: Update module testing description: Update module testing metadata operationId: module-registry#update-module-testing parameters: - name: scope_org in: query description: module org allowEmptyValue: true schema: type: string description: module org example: Est autem laudantium vel alias ipsam vel. example: Quidem officiis voluptatem. - name: scope_project in: query description: module project allowEmptyValue: true schema: type: string description: module project example: Occaecati non. example: Praesentium quod ut neque ab quod esse. - name: id in: path description: module id required: true schema: type: string description: module id example: Sit enim quo impedit in totam. example: Quibusdam officiis soluta a deleniti ipsum. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Tempora quaerat quia dicta minima illo. example: Aut aspernatur omnis rerum. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTestingRequest' example: pipeline_id: - Dolor mollitia et. - Necessitatibus omnis qui. - Voluptas aut nihil magni optio enim modi. - Praesentium et consectetur velit omnis est ducimus. pipeline_org: Molestiae qui ea sit eaque. pipeline_project: Alias blanditiis. provider_connector: Qui ipsa ex voluptatem et vel soluta. provisioner_type: Rerum enim repellendus quaerat aliquid doloribus quidem. provisioner_version: Ut similique impedit sint est deleniti et. release_pipeline: Ducimus quibusdam ut. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{id}/versions/{version}: delete: tags: - module-registry summary: Delete module version description: Delete a specific version from a module in the module registry operationId: module-registry#delete-module-versions parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Omnis voluptatibus et explicabo et totam aut. example: Ut ut ut libero. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Cupiditate culpa expedita quo iusto. example: Enim enim velit aspernatur id quibusdam quia. - name: id in: path description: module id required: true schema: type: string description: module id example: Et qui autem velit. example: Qui quo. - name: version in: path description: version to delete required: true schema: type: string description: version to delete example: Optio consequatur quo. example: Atque impedit. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Et nobis est ea illo eveniet eos. example: Atque autem minima quos ullam. responses: '204': description: No Content response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/examples/file: get: tags: - module-registry summary: Get module example file description: Download a single file from a module version's examples/ tree. The path must begin with "examples/" and identify a file (not a directory). operationId: module-registry#get-module-example-file parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Aut deleniti assumenda pariatur. example: Voluptatem tempora animi omnis magnam. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Id dicta et molestias tempora accusamus placeat. example: Ea et ut quidem consectetur magni qui. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Vitae laborum excepturi magnam ex. example: Voluptas cumque. - name: path in: query description: relative path under the module root; must begin with "examples/" and identify a file (e.g. "examples/iam-account/main.tf" or "examples/iam-account/modules/foo/main.tf") allowEmptyValue: true required: true schema: type: string description: relative path under the module root; must begin with "examples/" and identify a file (e.g. "examples/iam-account/main.tf" or "examples/iam-account/modules/foo/main.tf") example: z8 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: k65 - name: module_id in: path description: module id required: true schema: type: string description: module id example: Laboriosam adipisci aspernatur accusantium qui voluptatibus. example: Dolores reiciendis et iste numquam. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Qui quaerat pariatur numquam. example: Qui aut est eum totam. responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/examples/tree: get: tags: - module-registry summary: List module example tree description: List the immediate children (files and subdirectories) at the given path within a module version's examples/ tree. The path must be exactly "examples" (root listing) or begin with "examples/". Returns one level of entries, each tagged as a file or directory. operationId: module-registry#list-module-example-tree parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Veritatis aut adipisci vero. example: Iste exercitationem officiis. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Consequuntur soluta neque laboriosam corporis. example: Est vitae. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Beatae sequi deserunt ut tenetur minima. example: Sapiente veniam animi dolorem ab non. - name: path in: query description: relative path under the module root; must be "examples" or begin with "examples/" allowEmptyValue: true required: true schema: type: string description: relative path under the module root; must be "examples" or begin with "examples/" example: k05 pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: dqh - name: module_id in: path description: module id required: true schema: type: string description: module id example: Sequi labore veritatis ad. example: Omnis assumenda. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Est odio error eos. example: Ab cumque quia. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleExampleTreeResponse' example: items: - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/metadata: get: tags: - module-registry summary: List module metadata description: List the module metadata from the module registry operationId: module-registry#list-metadata-by-module parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Ab voluptas. example: Dolores quos. - name: submodule in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Nemo suscipit. example: Sed excepturi maxime veniam. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Sed dolorem eos ut perferendis. example: Voluptatum optio. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Qui eum et aperiam eveniet. example: Voluptates repellat fugiat sed ut. - name: module_id in: path description: module id required: true schema: type: string description: module id example: Saepe libero. example: Sint maiores. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Et similique. example: Odit vitae dignissimos rem itaque nisi ut. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleMetadataResponse' example: account: Voluptas voluptatum veritatis repellendus eligendi quo qui. dependencies: - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. examples_paths: - A consequatur voluptatem sequi repellat. - Soluta tempore non voluptatum. - Quia enim repellat. metadata_error: Repellendus aut nesciunt. module_version: Autem nam laborum facilis enim. name: Eaque vel ut recusandae nisi cupiditate. outputs: - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true providers: - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. resources: - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. scope_org: Est maiores beatae hic. scope_project: Corrupti ut voluptatem sit quod dolor. submodule: - Maiores at aliquid minus ut et sunt. - Reprehenderit sit. system: Atque et sequi et et explicabo. variables: - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{module_id}/readme: get: tags: - module-registry summary: List module readme description: List the module readme from the module registry operationId: module-registry#list-readme-by-id parameters: - name: version in: query description: version of the module allowEmptyValue: true required: true schema: type: string description: version of the module example: Repudiandae laudantium odit officiis qui. example: Eum est enim facere qui aliquam. - name: submodule in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Explicabo necessitatibus eos facere. example: Quod ad nihil consequatur iure. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Nisi consequatur omnis. example: Vitae error. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Vitae corrupti. example: Repellat illum reiciendis eos. - name: module_id in: path description: module id required: true schema: type: string description: module id example: Et sit possimus. example: Ipsam minima illo eveniet. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Veritatis sequi illum cumque. example: Omnis voluptate consectetur eligendi et voluptas. responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{moduleId}/events: post: tags: - module-registry summary: Send an event related with a module execution operationId: module-registry#send-module-event parameters: - name: moduleId in: path description: module id associated with this event required: true schema: type: string description: module id associated with this event example: v minLength: 1 maxLength: 1024 example: cr7 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendModuleEventRequest' example: account: Porro numquam animi molestias vero praesentium sed. eventType: Odit hic porro enim nostrum nostrum molestiae. metadata: pipeline: Est porro ullam omnis sit. pipeline_execution_id: Nisi eveniet. pipeline_execution_number: Deserunt exercitationem sit consequatur. pipeline_name: Dolores et magni. pipeline_stage_id: Reiciendis unde in temporibus sit laborum. trigger: Nam ex maxime consequatur dolor facere.: Ut quod qui iure rerum. Sed voluptatem non.: Inventore eos officiis. org: Id rem illum accusantium ut voluptate nisi. project: Placeat quidem velit explicabo. responses: '200': description: OK response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{moduleId}/executions: get: tags: - module-registry summary: List executions for a specific module description: List all module executions for a module. operationId: module-registry#list-module-executions-id parameters: - name: limit in: query description: Limit is the number of records to return for a page. allowEmptyValue: true schema: type: integer description: Limit is the number of records to return for a page. default: 30 example: 30 format: int64 minimum: 1 maximum: 1000 example: 30 - name: page in: query description: Page is the page number to return relative to the page 'limit'. allowEmptyValue: true schema: type: integer description: Page is the page number to return relative to the page 'limit'. default: 1 example: 1 format: int64 minimum: 1 example: 1 - name: pipeline_execution_id in: query description: Pipeline identifier allowEmptyValue: true schema: type: string description: Pipeline identifier example: Voluptatem iusto aut occaecati fuga error. example: Ipsa quo voluptatum aut. - name: status in: query description: Status of the execution allowEmptyValue: true schema: type: array items: type: string example: Earum voluptas est provident maiores autem. description: Status of the execution example: - Sunt mollitia aut quas mollitia sint. - Blanditiis corporis non. - Expedita placeat esse excepturi quia et quae. - Deserunt a suscipit ut. example: - Sed ullam distinctio eos. - Laboriosam esse. - Nisi et non consequatur aut facere. - name: start_time in: query description: Specify the start time for the query allowEmptyValue: true schema: type: integer description: Specify the start time for the query example: 1691150743950 format: int64 example: 1691150743950 - name: end_time in: query description: Specify the end time limit for the query allowEmptyValue: true schema: type: integer description: Specify the end time limit for the query example: 1691150743950 format: int64 example: 1691150743950 - name: module_onboarding in: query description: Is module onboarding execution allowEmptyValue: true schema: type: boolean description: Is module onboarding execution default: false example: false example: false - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Aspernatur est porro. example: Dolorem dolore provident autem amet ut. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Et corporis rerum iste autem officia. example: Laudantium dolor et. - name: moduleId in: path description: Module identifier required: true schema: type: string description: Module identifier example: Saepe eligendi distinctio. example: Optio sit voluptates delectus quia et. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: y0p minLength: 1 maxLength: 128 example: z95 responses: '200': description: OK response. headers: x-page-size: description: Current page size schema: type: integer description: Current page size example: 50 format: int64 example: 50 x-total-items: description: Total items available schema: type: integer description: Total items available example: 1800 format: int64 example: 1800 x-total-pages: description: Total pages available schema: type: integer description: Total pages available example: 36 format: int64 example: 36 content: application/json: schema: $ref: '#/components/schemas/ModuleExecutionResourceCollection' example: - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' post: tags: - module-registry summary: Create a new module execution description: Create a new module execution. operationId: module-registry#create-module-execution parameters: - name: moduleId in: path description: The unique identifier for the associated module required: true schema: type: string description: The unique identifier for the associated module example: Accusamus culpa ut. example: Amet qui numquam necessitatibus et. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleExecutionRequest' example: account: Eos maxime ad et delectus ut soluta. module_onboarding: true pipeline: Esse molestiae enim nihil quod deleniti. pipeline_org: Sit non dicta. pipeline_project: Autem cupiditate sit quo et fugit. pipelineExecutionId: Cupiditate itaque corrupti eaque laudantium velit. pipelineStageId: Ut ullam quos sit voluptatum iste. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateModuleExecutionResponse' example: account: Est facere cum cupiditate cumque neque. created: 4061667798647593000 metadata: pipeline: Molestias nihil nam reprehenderit. pipeline_execution_id: Ea qui quo magnam cupiditate laudantium nostrum. pipeline_execution_number: Est quo voluptas est. pipeline_name: Quasi rerum aperiam. pipeline_stage_id: Corrupti ducimus sed minus qui illo ut. trigger: Aut voluptatem.: Consequatur est non magni eum est. Cumque quis enim odio quia ut molestiae.: Nihil quisquam rerum est iste et alias. Nam in.: Doloremque sint omnis quis maxime et molestiae. module_onboarding: false moduleId: Sunt molestiae ipsa culpa aspernatur vero. org: Quasi enim. project: Nihil numquam natus delectus ab nam. status: Molestiae a quia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/examples: post: tags: - module-registry summary: Create module example description: Endpoint to upload README and Terraform source files for a single example directory of a module version operationId: module-registry#post-module-example parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Laborum rerum voluptatem consequatur. example: Officiis tempora quis possimus deleniti odit expedita. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Sit iure a et eum nihil sunt. example: Sit nesciunt id cum nam ipsa est. - name: path in: query description: relative path under the module root; must be "examples" or begin with "examples/" (e.g. "examples/eks-auto-mode") allowEmptyValue: true required: true schema: type: string description: relative path under the module root; must be "examples" or begin with "examples/" (e.g. "examples/eks-auto-mode") example: hx pattern: ^[a-zA-Z0-9_-][a-zA-Z0-9._/-]*$ minLength: 1 maxLength: 1024 example: x - name: name in: path description: module name required: true schema: type: string description: module name example: Iure aut minus quam. example: Eaque molestias. - name: system in: path description: system name required: true schema: type: string description: system name example: Cumque nesciunt quaerat officiis deserunt dolor. example: Asperiores totam omnis laudantium distinctio. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Rerum delectus fugit laudantium perferendis. example: Ut dolores debitis amet omnis voluptates dolore. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Optio ut harum placeat architecto omnis. example: Dolores id. - name: Content-Type in: header description: Content-Type header (multipart/form-data with boundary) allowEmptyValue: true required: true schema: type: string description: Content-Type header (multipart/form-data with boundary) example: Qui dolorum velit. example: Facilis itaque dolor aspernatur aut vel perferendis. - name: Content-Length in: header description: Size in bytes of the multipart body allowEmptyValue: true schema: type: integer description: Size in bytes of the multipart body example: 4870268399397385000 format: int64 example: 1655906209272749600 responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/metadata: post: tags: - module-registry summary: Create module data description: Create a new module in the module registry operationId: module-registry#module-parsed-data parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Officia sint iure aspernatur eveniet reiciendis rerum. example: Debitis corporis perspiciatis ut nemo. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Sequi non. example: Unde et. - name: name in: path description: module name required: true schema: type: string description: module name example: Et quaerat. example: Exercitationem consequatur consectetur. - name: system in: path description: system name required: true schema: type: string description: system name example: Quia eligendi. example: Commodi vel vero. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Enim qui velit. example: Magnam quisquam aut error et tenetur. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Doloribus nostrum. example: Nisi omnis consequatur. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleDataRequest' example: download_url: Et perferendis ut temporibus sed commodi animi. error: Veritatis ut.: Quia omnis. examples_paths: - Porro assumenda similique voluptas. - Nihil esse consequuntur cupiditate sit ut voluptate. - Voluptatum placeat eligendi. git_tag: At qui. metadata: Ducimus sit. repo_url: Vitae in eius. submodule_name: Aut porro mollitia quia in quo. submodule_paths: - Possimus vitae qui commodi qui explicabo. - Rerum ducimus officia at dolorum sed tempore. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/readme: post: tags: - module-registry summary: Create module readme description: Endpoint to push the Readme for a given module operationId: module-registry#post-module-readme parameters: - name: submoduleName in: query description: submodule name allowEmptyValue: true schema: type: string description: submodule name example: Sunt incidunt. example: Quod expedita non tempore et provident. - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Aut occaecati fuga voluptatem est. example: Rerum voluptatibus harum. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Consequatur ipsa. example: Qui iste. - name: name in: path description: module name required: true schema: type: string description: module name example: Ea harum repellat. example: Voluptatem qui deserunt est quia magnam dignissimos. - name: system in: path description: system name required: true schema: type: string description: system name example: Dicta vitae. example: Ipsum enim enim voluptates et. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Voluptatem at esse fugit nesciunt aut. example: Tempora at et. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Eaque aliquam est exercitationem praesentium qui molestiae. example: Quia omnis aut et quibusdam tempore ut. - name: Content-Length in: header description: Size in bytes of the readme allowEmptyValue: true schema: type: integer description: Size in bytes of the readme example: 2374365714865187000 format: int64 example: 7192753419360744000 responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/{version}/upload: post: tags: - module-registry summary: Upload module artifact files description: Upload module artifact to the module registry operationId: module-registry#post-module-artifact parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Magnam quo eius non. example: Dolore tenetur blanditiis sed. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Quia error est consequuntur aspernatur voluptas labore. example: Ipsam eos est quis. - name: name in: path description: Module artifact name required: true schema: type: string description: Module artifact name example: Ab nulla ad atque rem provident qui. example: Eos et quos illum vel itaque. - name: system in: path description: Module artifact system required: true schema: type: string description: Module artifact system example: Quam iure ut enim nihil. example: Aliquam facere cumque. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Omnis accusamus odit. example: Debitis minima ut harum asperiores voluptatibus est. - name: Harness-Account in: header description: Account ID allowEmptyValue: true required: true schema: type: string description: Account ID example: harness example: harness - name: Content-Disposition in: header description: Content-Disposition header allowEmptyValue: true required: true schema: type: string description: Content-Disposition header example: Enim possimus labore sit. example: Consequatur illum doloremque in perspiciatis. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/{name}/{system}/tags: post: tags: - module-registry summary: Create module tags description: List all tags for a given module operationId: module-registry#post-module-tags parameters: - name: scope_org in: query description: Organization identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 example: my_org - name: scope_project in: query description: Project identifier where the module is scoped. allowEmptyValue: true schema: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 example: my_project - name: name in: path description: Human-readable name of the module. Must be unique within the same scope and system. required: true schema: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 example: my-vpc-module - name: system in: path description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). required: true schema: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 example: aws - name: Harness-Account in: header description: Harness account ID that owns the module. allowEmptyValue: true required: true schema: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 example: abc123DEFghiJKL requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModuleTagsRequest' example: error: Nesciunt pariatur et quo possimus nostrum.: Facilis id velit dignissimos dolor exercitationem et. tags: - Nihil voluptatem optio distinctio repudiandae rerum dolorem. - Nihil voluptatibus eum dolore quae. responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/connectors: get: tags: - module-registry summary: List connectors description: List all connectors from the module registry for a specific account operationId: module-registry#list-connectors parameters: - name: org in: query description: organization name allowEmptyValue: true schema: type: string description: organization name example: Labore qui sapiente autem quisquam et ducimus. example: Rerum asperiores consequatur occaecati repellat dolorem. - name: project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Quae hic eaque sunt facilis. example: Et aut id mollitia ipsam. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Rerum optio est ut. example: Et nobis sint molestias aut voluptatem. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Assumenda nemo qui autem libero. example: - Quia consequuntur et sapiente. - At consequatur eum. - Molestiae quasi. example: - Et corrupti sapiente. - Nam voluptas voluptas quae eum hic. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/lifecycle/batch-check: post: tags: - module-registry summary: Batch check module lifecycle status description: Batch-check lifecycle status for a list of modules resolved during terraform init; only violations are returned operationId: module-registry#batch-check-module-lifecycle parameters: - name: Harness-Account in: header description: Harness account ID allowEmptyValue: true required: true schema: type: string description: Harness account ID example: Tempore tempora voluptatem. example: Voluptas aspernatur est. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCheckModuleLifecycleRequest' example: items: - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/BatchCheckModuleLifecycleResponse' example: results: - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/pipeline/onboarding: post: tags: - module-registry summary: Create onboarding pipeline description: Create a new onboarding pipeline for module registry operationId: module-registry#create-onboarding-pipeline parameters: - name: scope_org in: query description: module org name allowEmptyValue: true schema: type: string description: module org name example: Autem quo culpa. example: Et in. - name: scope_project in: query description: module project name allowEmptyValue: true schema: type: string description: module project name example: Quaerat modi in excepturi at. example: Est fuga unde dolorem sit et tempore. - name: Harness-Account in: header description: Account is the internal customer account ID. allowEmptyValue: true required: true schema: type: string description: Account is the internal customer account ID. example: g minLength: 1 maxLength: 128 example: y requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOnboardingPipelineRequest' example: org: b project: xj responses: '201': description: Created response. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/api/modules/providers: get: tags: - module-registry summary: List module providers description: List the distinct providers (module_system values) in the module registry for a scope operationId: module-registry#list-module-providers parameters: - name: scope_org in: query description: org name allowEmptyValue: true schema: type: string description: org name example: Et qui maiores. example: Rem ratione odio fuga nam. - name: scope_project in: query description: project name allowEmptyValue: true schema: type: string description: project name example: Dignissimos esse ipsum qui voluptates laborum odit. example: Rerum porro quis dolores ut aut. - name: Harness-Account in: header description: account name allowEmptyValue: true required: true schema: type: string description: account name example: Assumenda qui temporibus sapiente. example: Aut sunt non rerum et id. responses: '200': description: OK response. content: application/json: schema: type: array items: type: string example: Dolor est hic ullam error amet. example: - Sint minus quia aperiam quibusdam debitis et. - Cum ea sunt cumque eos. - Reprehenderit voluptatem culpa eaque. - Sit facilis in cum in eos sint. example: - Sed sint asperiores repellat beatae expedita. - Commodi eos est error molestiae. - Qui sit quas. - Eum rem odio quia. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/registry/account/{namespace}/{name}/{system}/{version}/download: get: tags: - module-registry summary: Download module description: Download a module given a specific version operationId: module-registry#download parameters: - name: namespace in: path description: namespace of the module required: true schema: type: string description: namespace of the module example: Explicabo fugit explicabo dolore officiis rerum quos. example: Quasi magnam id numquam. - name: name in: path description: module name required: true schema: type: string description: module name example: Error dolorem temporibus. example: Sint perspiciatis tempora. - name: system in: path description: system name required: true schema: type: string description: system name example: Sed minus perspiciatis reiciendis quos velit. example: Explicabo voluptatibus quae ut in voluptatem. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Facilis sunt molestiae. example: Necessitatibus rem earum. responses: '200': description: OK response. headers: X-Terraform-Get: description: url of the module for a given version schema: type: string description: url of the module for a given version example: Ut voluptatum quidem eius et ea. example: Dolorem voluptas cumque consequatur nam voluptas. content: application/json: schema: $ref: '#/components/schemas/DownloadModuleResponse' example: location: Ex nesciunt architecto tenetur. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/registry/account/{namespace}/{name}/{system}/{version}/download/file: get: tags: - module-registry summary: Download module file tarball description: Download a module given a specific version operationId: module-registry#getModule parameters: - name: token in: query description: token for authentication allowEmptyValue: true required: true schema: type: string description: token for authentication example: Et commodi consequatur error. example: Mollitia sed laudantium animi in quia doloremque. - name: namespace in: path description: namespace of the module required: true schema: type: string description: namespace of the module example: Veritatis asperiores aspernatur eius. example: Sequi quia ipsa ducimus et. - name: name in: path description: module name required: true schema: type: string description: module name example: Molestiae et. example: Dicta placeat atque natus eos eveniet rerum. - name: system in: path description: system name required: true schema: type: string description: system name example: Fuga et eius ratione minus nulla ad. example: Consequatur dolores modi consequatur eos aut voluptas. - name: version in: path description: version of the module required: true schema: type: string description: version of the module example: Velit ipsa autem reprehenderit dolores. example: Similique similique maxime sed modi et est. responses: '200': description: OK response. content: application/json: schema: type: string format: binary '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' /iacm/registry/account/{namespace}/{name}/{system}/versions: get: tags: - module-registry summary: List module versions description: list-module-versions returns an array of versions for a given module operationId: module-registry#list-versions parameters: - name: namespace in: path description: namespace of the module required: true schema: type: string description: namespace of the module example: Odit cupiditate ipsa. example: Saepe explicabo iusto excepturi et quae. - name: name in: path description: module name required: true schema: type: string description: module name example: Rem enim aut incidunt at. example: Quos optio amet. - name: system in: path description: system name required: true schema: type: string description: system name example: Vero iste neque. example: Sit placeat eligendi quia vero eum. responses: '200': description: OK response. content: application/json: schema: $ref: '#/components/schemas/ListModuleVersionsResponse' example: modules: - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. '400': description: 'BadRequestError: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '401': description: 'UnauthorizedError: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '403': description: 'ForbiddenError: Forbidden response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '404': description: 'NotFoundError: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '408': description: 'TimeoutError: Request Timeout response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '409': description: 'ConflictError: Conflict response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '423': description: 'LockedError: Locked response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '499': description: 'ContextCancelledError: response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '500': description: 'InternalServerError: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' '502': description: 'BadGatewayError: Bad Gateway response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/IaCMError' components: schemas: HarnessIacmModuleRegistryModuleTestingMetadata: type: object properties: account: type: string description: Account is the internal customer account ID. example: 2nh minLength: 1 maxLength: 128 org: type: string description: Org is the organisation identifier. example: r0i minLength: 1 maxLength: 128 pipelines: type: array items: type: string example: Maxime doloremque in. description: pipelines where the testing is enabled example: - Molestiae iste occaecati velit nostrum optio beatae. - Hic hic officiis ut exercitationem. - Molestiae omnis quis placeat. project: type: string description: Project is the project identifier. example: j minLength: 1 maxLength: 128 provider_connector: type: string description: provider connector for testing purposes example: Dolor quo. provisioner_type: type: string description: provisioner type for testing purposes example: Est officia aliquam est est. provisioner_version: type: string description: provisioner version for testing purposes example: Neque qui nam maiores molestias optio commodi. release_pipeline: type: string description: release pipeline example: Vel nostrum inventore. example: account: f org: nh pipelines: - Nisi voluptatem nihil amet molestias. - In dolorum blanditiis. - Quam est eos et. - Quia qui commodi et laborum id. project: 5e provider_connector: Et enim perspiciatis sint voluptas magni. provisioner_type: Eaque quibusdam dolor aut. provisioner_version: Occaecati neque. release_pipeline: Esse quidem voluptates facere. required: - account - org - project - provisioner_type - provisioner_version - provider_connector - pipelines HarnessIacmModuleRegistryVersionTypes: type: object properties: git_version: type: string description: git version example: Ipsum nam at ex natus fugit. module_version: type: string description: module version example: Eum provident dicta facere atque. description: Returns the module_version and git_version for a specific module example: git_version: Nihil saepe inventore maiores. module_version: Ipsum veritatis pariatur perspiciatis. required: - module_version - git_version PutModuleLifecycleResponse: type: object properties: deprecated_action: type: string description: Enforcement action for deprecated-tier versions default: fail example: fail enum: - no_action - warn - fail overrides: type: array items: $ref: '#/components/schemas/ModuleLifecycleOverride' description: Manual per-version tier overrides example: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 maxItems: 1000 supported_action: type: string description: Enforcement action for supported-tier versions default: no_action example: warn enum: - no_action - warn - fail supported_count: type: integer description: Number of most-recent non-pre-release versions classified as supported example: 3 format: int64 minimum: 1 warning_action: type: string description: Enforcement action for warning-tier versions default: warn example: no_action enum: - no_action - warn - fail warning_count: type: integer description: Number of versions immediately after the supported window classified as warning example: 2 format: int64 minimum: 0 example: deprecated_action: warn overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: no_action supported_count: 3 warning_action: no_action warning_count: 2 required: - supported_count - warning_count - supported_action - warning_action - deprecated_action ListModuleByIDResponse: type: object properties: account: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 1823402865624329700 format: int64 description: type: string description: Free-form text describing the purpose and usage of the module. example: Provisions a VPC with public and private subnets. domain_prefix: type: string description: Domain prefix for the module example: Cum natus molestias doloremque et. git_tag_style: type: string description: Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'. example: module-name-* id: type: string description: module id example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: type: string description: error while retrieving the module example: Facilis tempora id. name: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 namespace: type: string description: Namespace derived from account, org and project for use with the Terraform module registry example: Totam ut aut soluta nobis. onboarding_pipeline: type: string description: Identifier of the Harness pipeline used for module onboarding and metadata sync. example: Module_Onboarding_Pipeline onboarding_pipeline_org: type: string description: Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided. example: my_org onboarding_pipeline_project: type: string description: Project where the onboarding pipeline is defined. Defaults to scope_project if not provided. example: my_project onboarding_pipeline_sync: type: boolean description: When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed. default: false example: false onboarding_pipeline_wh: type: string description: Webhook identifier used to trigger the onboarding pipeline on Git events. default: '' example: webhook_abc123 org: type: string description: Organization identifier where the Git connector is defined. Defaults to scope_org if not provided. example: my_org maxLength: 1024 project: type: string description: Project identifier where the Git connector is defined. Defaults to scope_project if not provided. example: my_project maxLength: 1024 repository: type: string description: Name of the Git repository that contains the module source code. example: my-terraform-modules repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source. example: my_github_connector repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_url: type: string description: Repository url. example: Illum provident ut dolore qui eos. scope_org: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 scope_project: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 storage_type: type: string description: Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files. default: git_reference example: artifact enum: - git_reference - artifact synced: type: integer description: Synced is the unix timestamp at which the resource was synced for the last time in milliseconds. example: 5466047983445284000 format: int64 system: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 tags: type: string description: Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws). example: Possimus reiciendis laboriosam harum porro. testing_enabled: type: boolean description: testing enabled example: true testing_metadata: $ref: '#/components/schemas/HarnessIacmModuleRegistryModuleTestingMetadata' updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 8016664365127336000 format: int64 version_statuses: type: object description: Map of module version to lifecycle status (supported, warning, deprecated). Populated only when the lifecycle feature flag is enabled. example: Et incidunt.: Et occaecati. Maxime asperiores.: Aut sapiente cumque. additionalProperties: type: string example: Occaecati et asperiores. versions: type: array items: type: string example: Consequatur consequuntur repudiandae. description: versions example: - Eius dolor. - Laborum nihil dignissimos qui. - Eum et facere. - Voluptas dicta qui dolor ut. example: account: abc123DEFghiJKL created: 8767617040713148000 description: Provisions a VPC with public and private subnets. domain_prefix: Consequatur quaerat ex et libero quia qui. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Perferendis molestias reprehenderit at laboriosam velit. name: my-vpc-module namespace: Adipisci ut qui. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: false onboarding_pipeline_wh: webhook_abc123 org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Iure ut qui aut. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8725144430772911000 system: aws tags: Tempora magni sequi. testing_enabled: true testing_metadata: account: r org: y pipelines: - Eos ex voluptas consequatur asperiores fugit. - Molestiae dolorum rerum sed voluptatibus veniam fuga. - Assumenda magni qui vel eaque repellendus ducimus. project: h provider_connector: Quod est illo tempore dolores. provisioner_type: Pariatur velit quasi. provisioner_version: Dolorum non labore tenetur impedit doloribus. release_pipeline: Architecto odio iure eius. updated: 89056182533833940 version_statuses: Sed dolor exercitationem perspiciatis quaerat.: Blanditiis magnam. Sequi quia.: Harum quae nulla sint est. versions: - Eaque quia sit nihil. - Omnis dicta aut aut. - Aut impedit itaque. - Modi corrupti possimus dolores amet at. required: - account - name - system - id - created - updated - synced ListModuleExampleTreeResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ExampleTreeItem' description: immediate children at the requested path example: - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. example: items: - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. - content_type: file name: Possimus iure rerum ipsam consequatur. path: Facere minus aut cupiditate. required: - items IaCMError: type: object properties: fault: type: boolean description: Is the error a server-side fault? example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: false timeout: type: boolean description: Is the error a timeout? example: true example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false timeout: true required: - name - id - message - temporary - timeout - fault GetModuleLifecycleResponse: type: object properties: deprecated_action: type: string description: Enforcement action for deprecated-tier versions default: fail example: no_action enum: - no_action - warn - fail overrides: type: array items: $ref: '#/components/schemas/ModuleLifecycleOverride' description: Manual per-version tier overrides example: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 maxItems: 1000 supported_action: type: string description: Enforcement action for supported-tier versions default: no_action example: fail enum: - no_action - warn - fail supported_count: type: integer description: Number of most-recent non-pre-release versions classified as supported example: 3 format: int64 minimum: 1 warning_action: type: string description: Enforcement action for warning-tier versions default: warn example: fail enum: - no_action - warn - fail warning_count: type: integer description: Number of versions immediately after the supported window classified as warning example: 2 format: int64 minimum: 0 example: deprecated_action: fail overrides: - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 - reason: r11 tier: warning version: v2.1.0 supported_action: no_action supported_count: 3 warning_action: fail warning_count: 2 required: - supported_count - warning_count - supported_action - warning_action - deprecated_action ModuleLifecycleRule: type: object properties: deprecated_action: type: string description: Enforcement action for deprecated-tier versions default: fail example: fail enum: - no_action - warn - fail overrides: type: array items: $ref: '#/components/schemas/ModuleLifecycleOverride' description: Manual per-version tier overrides example: - reason: q6a tier: deprecated version: v2.1.0 - reason: q6a tier: deprecated version: v2.1.0 - reason: q6a tier: deprecated version: v2.1.0 maxItems: 1000 supported_action: type: string description: Enforcement action for supported-tier versions default: no_action example: no_action enum: - no_action - warn - fail supported_count: type: integer description: Number of most-recent non-pre-release versions classified as supported example: 3 format: int64 minimum: 1 warning_action: type: string description: Enforcement action for warning-tier versions default: warn example: warn enum: - no_action - warn - fail warning_count: type: integer description: Number of versions immediately after the supported window classified as warning example: 2 format: int64 minimum: 0 description: Lifecycle rule configuration for a module registry module example: deprecated_action: no_action overrides: - reason: q6a tier: deprecated version: v2.1.0 - reason: q6a tier: deprecated version: v2.1.0 - reason: q6a tier: deprecated version: v2.1.0 supported_action: fail supported_count: 3 warning_action: fail warning_count: 2 required: - supported_count - warning_count - supported_action - warning_action - deprecated_action SendModuleEventRequest: type: object properties: account: type: string description: account name example: Distinctio eveniet minus voluptatibus. eventType: type: string description: The type of event that occurred example: Atque quos iusto tempora. metadata: $ref: '#/components/schemas/ModuleExecutionMetadata' org: type: string description: pipeline org example: Enim amet quidem eaque occaecati labore. project: type: string description: pipeline project example: Iusto sint aperiam debitis similique. example: account: Dolorum facere consequatur voluptates odio. eventType: Sequi amet ipsum aliquid vel officiis quo. metadata: pipeline: Est porro ullam omnis sit. pipeline_execution_id: Nisi eveniet. pipeline_execution_number: Deserunt exercitationem sit consequatur. pipeline_name: Dolores et magni. pipeline_stage_id: Reiciendis unde in temporibus sit laborum. trigger: Nam ex maxime consequatur dolor facere.: Ut quod qui iure rerum. Sed voluptatem non.: Inventore eos officiis. org: Rerum nostrum aspernatur quaerat odit voluptatum est. project: Molestiae quaerat qui rem nulla. required: - eventType - account - org - project ModuleLifecycleOverride: type: object properties: reason: type: string description: Optional reason for this override example: e1a maxLength: 1000 tier: type: string description: Lifecycle tier to assign to this version example: deprecated enum: - supported - warning - deprecated version: type: string description: Version string to override example: v2.1.0 minLength: 1 description: Manual lifecycle tier override for a specific module version example: reason: i0f tier: deprecated version: v2.1.0 required: - version - tier HarnessIacmModuleRegistryVersions: type: object properties: versions: type: array items: $ref: '#/components/schemas/HarnessIacmModuleRegistryVersionTypes' description: list of versions for a given module example: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. description: Versions returns the list of versions for a given module example: versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. required: - versions ModuleResource: type: object properties: account: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 3472031968713895000 format: int64 description: type: string description: Free-form text describing the purpose and usage of the module. example: Provisions a VPC with public and private subnets. domain_prefix: type: string description: Domain prefix for the module example: Ut sit rerum qui explicabo quis. git_tag_style: type: string description: Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'. example: module-name-* id: type: string description: module id example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: type: string description: error while retrieving the module example: Cupiditate officiis ipsa et placeat atque. name: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 namespace: type: string description: Namespace derived from account, org and project for use with the Terraform module registry example: Aut quam omnis perspiciatis. onboarding_pipeline: type: string description: Identifier of the Harness pipeline used for module onboarding and metadata sync. example: Module_Onboarding_Pipeline onboarding_pipeline_org: type: string description: Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided. example: my_org onboarding_pipeline_project: type: string description: Project where the onboarding pipeline is defined. Defaults to scope_project if not provided. example: my_project onboarding_pipeline_sync: type: boolean description: When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed. default: false example: false org: type: string description: Organization identifier where the Git connector is defined. Defaults to scope_org if not provided. example: my_org maxLength: 1024 project: type: string description: Project identifier where the Git connector is defined. Defaults to scope_project if not provided. example: my_project maxLength: 1024 repository: type: string description: Name of the Git repository that contains the module source code. example: my-terraform-modules repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source. example: my_github_connector repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' repository_url: type: string description: Repository url. example: Neque omnis qui accusantium. scope_org: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 scope_project: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 storage_type: type: string description: Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files. default: git_reference example: artifact enum: - git_reference - artifact synced: type: integer description: Synced is the unix timestamp at which the resource was synced for the last time in milliseconds. example: 6516881391693389000 format: int64 system: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 tags: type: string description: Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws). example: Eligendi praesentium debitis. testing_enabled: type: boolean description: testing enabled example: true testing_metadata: $ref: '#/components/schemas/ModuleTestingMetadata' updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 4206214064992028000 format: int64 version_statuses: type: object description: Map of module version to lifecycle status (supported, warning, deprecated). Populated only when the lifecycle feature flag is enabled. example: Deserunt voluptate voluptas et.: Vel id autem voluptatum voluptatem velit incidunt. Rerum perferendis hic temporibus dolores aut repellat.: Tempora quam est maiores in. Velit atque necessitatibus soluta id omnis.: Saepe quaerat. additionalProperties: type: string example: Sint labore. versions: type: array items: type: string example: Deserunt sit. description: versions example: - Repudiandae temporibus. - Et eum ipsum quam saepe enim exercitationem. - Aliquid illum. description: ModuleResource result type (default view) example: account: abc123DEFghiJKL created: 6045581154085055000 description: Provisions a VPC with public and private subnets. domain_prefix: Atque ipsa. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aperiam atque qui laudantium iusto. name: my-vpc-module namespace: Ut iste aliquid vel exercitationem ipsa. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: false org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Officiis similique. scope_org: my_org scope_project: my_project storage_type: artifact synced: 3901995255393526000 system: aws tags: Laudantium repudiandae iste et voluptates et minus. testing_enabled: true testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 5522659513031373000 version_statuses: Eligendi adipisci occaecati magni.: Voluptatem et nihil sint ut facilis. versions: - Quam tempora non. - Maiores et ea doloremque autem quibusdam. required: - account - name - system - id - created - updated - synced CreateModuleExecutionResponse: type: object properties: account: type: string description: account name example: Sed perferendis error explicabo enim. created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 3712325767704545000 format: int64 metadata: $ref: '#/components/schemas/ModuleExecutionMetadata' module_onboarding: type: boolean description: Is module onboarding execution default: false example: false moduleId: type: string description: The unique identifier for the associated module example: Praesentium qui sit aliquid voluptatem quia. org: type: string example: Quis sequi. project: type: string example: Accusantium voluptate a dolor. status: type: string description: The overall status of the execution example: Reiciendis soluta incidunt quia nihil et. example: account: Itaque maiores molestias recusandae ut dolorem quia. created: 2052231546877588500 metadata: pipeline: Molestias nihil nam reprehenderit. pipeline_execution_id: Ea qui quo magnam cupiditate laudantium nostrum. pipeline_execution_number: Est quo voluptas est. pipeline_name: Quasi rerum aperiam. pipeline_stage_id: Corrupti ducimus sed minus qui illo ut. trigger: Aut voluptatem.: Consequatur est non magni eum est. Cumque quis enim odio quia ut molestiae.: Nihil quisquam rerum est iste et alias. Nam in.: Doloremque sint omnis quis maxime et molestiae. module_onboarding: true moduleId: Voluptas ipsa non necessitatibus qui ipsa. org: Consectetur quis ad impedit sed necessitatibus. project: Quidem voluptatem. status: Nobis dicta sint magnam sapiente. required: - org - project - status - created - account - pipeline_org - pipeline_project - pipelineExecutionId - pipelineStageId - moduleId - pipeline ModuleExecutionMetadata: type: object properties: pipeline: type: string description: The unique identifier of any associated pipeline example: Occaecati voluptatem vel enim sit quia. pipeline_execution_id: type: string description: The unique identifier for any associated pipeline execution example: Veniam facere ipsa deleniti unde et. pipeline_execution_number: type: string description: The unique number for any associated pipeline execution example: Explicabo similique sit temporibus cumque. pipeline_name: type: string description: The name of any associated pipeline example: Dolor voluptatem unde voluptatem aliquid. pipeline_stage_id: type: string description: The unique identifier for the associated pipeline stage example: Repellat cupiditate earum laboriosam ipsam. trigger: type: object description: Trigger info for any associated pipeline execution example: Facilis minus dolorem neque rem vel illo.: Illum nobis sunt suscipit. Voluptatum ut dolor.: Eum quaerat libero. additionalProperties: true example: pipeline: Aperiam numquam at deserunt alias. pipeline_execution_id: Eos aliquid. pipeline_execution_number: Saepe non eos quaerat veniam qui. pipeline_name: Asperiores laudantium velit amet. pipeline_stage_id: Quia non quia. trigger: Eos quia similique atque expedita nemo.: Enim aliquam vitae accusamus. CreateOnboardingPipelineRequest: type: object properties: org: type: string description: Org is the organisation identifier. example: 0y minLength: 1 maxLength: 128 project: type: string description: Project is the project identifier. example: 55c minLength: 1 maxLength: 128 example: org: e project: 9xt required: - org - project ModuleExecutionResourceCollection: type: array items: $ref: '#/components/schemas/HarnessIacmModuleexecutionresource' example: - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. - account: Atque quaerat quasi eveniet nostrum. created: 4270900858918391300 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: true moduleId: Rerum reiciendis quasi voluptate. org: Eum modi atque cum. project: Commodi fuga aut itaque corrupti dignissimos. status: Rerum aut. DownloadModuleResponse: type: object properties: location: type: string description: location of the artifact example: Possimus neque officiis natus corporis omnis. example: location: Magnam in explicabo quia est. CreateModuleExecutionRequest: type: object properties: account: type: string description: account name example: Nemo doloremque debitis. module_onboarding: type: boolean description: Is module onboarding execution default: false example: true pipeline: type: string description: The unique identifier for the associated pipeline example: Ut explicabo fugiat sit non. pipeline_org: type: string description: pipeline org example: Recusandae et saepe error. pipeline_project: type: string description: pipeline project example: Non repellendus animi ratione ea dignissimos enim. pipelineExecutionId: type: string description: The unique identifier for the associated pipeline execution example: Amet beatae rerum amet non. pipelineStageId: type: string description: The unique identifier for the associated pipeline stage example: Culpa provident. example: account: Illum rerum eius fugiat eveniet. module_onboarding: true pipeline: Magni itaque consequatur ad consequatur. pipeline_org: A quas et vitae esse minus itaque. pipeline_project: Aut fugiat eum atque vitae voluptatem temporibus. pipelineExecutionId: Cumque nulla laudantium eos eos et qui. pipelineStageId: Nemo sunt enim. required: - account - pipeline_org - pipeline_project - pipelineExecutionId - pipelineStageId - pipeline ModuleTestingMetadata: type: object properties: account: type: string description: Account is the internal customer account ID. example: t minLength: 1 maxLength: 128 org: type: string description: Org is the organisation identifier. example: c8d minLength: 1 maxLength: 128 pipelines: type: array items: type: string example: Eos quia. description: pipelines where the testing is enabled example: - Molestiae nihil quia tenetur natus ad. - Rerum harum blanditiis ut. project: type: string description: Project is the project identifier. example: '4' minLength: 1 maxLength: 128 provider_connector: type: string description: provider connector for testing purposes example: Doloremque expedita voluptatem. provisioner_type: type: string description: provisioner type for testing purposes example: Fugit repudiandae atque deleniti at quibusdam quo. provisioner_version: type: string description: provisioner version for testing purposes example: Quasi eum iusto. release_pipeline: type: string description: release pipeline example: Omnis sed commodi quis. description: ModuleTestingMetadata result type (default view) example: account: xn org: m pipelines: - Nesciunt ad cupiditate sed blanditiis. - Et rerum voluptatem consectetur nulla. - Perferendis dignissimos explicabo quia. project: '8' provider_connector: Doloremque quos repudiandae. provisioner_type: Blanditiis fugit veniam. provisioner_version: Temporibus laudantium vero rerum eaque ex ex. release_pipeline: Voluptates minus consectetur incidunt neque aliquid aut. required: - account - org - project - provisioner_type - provisioner_version - provider_connector - pipelines ProviderMetadata: type: object properties: provider_name: type: string description: Provider name example: Facere natus enim tempora quia. provider_source: type: string description: Provider source example: Autem iusto aut aperiam provident. provider_version: type: string description: Provider version example: Ut et. example: provider_name: Qui quos qui. provider_source: Nisi occaecati corrupti dolore soluta. provider_version: Est et. UpdateModuleRequest: type: object properties: description: type: string description: Free-form text describing the purpose and usage of the module. example: Provisions a VPC with public and private subnets. git_tag_style: type: string description: Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'. example: module-name-* name: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 onboarding_pipeline: type: string description: Identifier of the Harness pipeline used for module onboarding and metadata sync. example: Module_Onboarding_Pipeline onboarding_pipeline_org: type: string description: Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided. example: my_org onboarding_pipeline_project: type: string description: Project where the onboarding pipeline is defined. Defaults to scope_project if not provided. example: my_project onboarding_pipeline_sync: type: boolean description: When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed. default: false example: true org: type: string description: Organization identifier where the Git connector is defined. Defaults to scope_org if not provided. example: my_org maxLength: 1024 project: type: string description: Project identifier where the Git connector is defined. Defaults to scope_project if not provided. example: my_project maxLength: 1024 repository: type: string description: Name of the Git repository that contains the module source code. example: my-terraform-modules repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source. example: my_github_connector repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' storage_type: type: string description: Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files. default: git_reference example: artifact enum: - git_reference - artifact system: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 tags: type: string description: Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws). example: Molestiae totam autem quod est libero. example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: false org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: git_reference system: aws tags: Vero earum est facere officia. required: - name - system EnableTestingRequest: type: object properties: pipeline_id: type: array items: type: string example: Ut perspiciatis repellendus quis enim. description: pipelines to create the webhooks to trigger the executions for testing example: - Eos ducimus deleniti est. - Explicabo vero corporis ea. - Facilis molestiae officia vero est. pipeline_org: type: string description: pipeline org example: Excepturi voluptates ipsum mollitia. pipeline_project: type: string description: pipeline project example: Facilis mollitia voluptatum officia aliquam. provider_connector: type: string description: provider connector default: '' example: Commodi nisi molestias fugit illo. provisioner_type: type: string description: provisioner type example: Perferendis minima laboriosam expedita amet. provisioner_version: type: string description: provisioner version example: Eligendi quis omnis minus. release_pipeline: type: string description: pipeline to create the webhooks for releases example: Quibusdam voluptatem quo aliquid. example: pipeline_id: - Sapiente animi porro. - Et officia. pipeline_org: Consequatur mollitia. pipeline_project: Error quis eius. provider_connector: Aut officia. provisioner_type: Placeat illum consectetur exercitationem quae. provisioner_version: Exercitationem ea maxime. release_pipeline: Voluptatum qui ut quia qui laudantium odio. required: - provisioner_type - provisioner_version - pipeline_org - pipeline_project HarnessIacmModuleexecutionresource: type: object properties: account: type: string description: account name example: Ut ut sunt facilis culpa voluptatem qui. created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 384738815438029950 format: int64 metadata: $ref: '#/components/schemas/ModuleExecutionMetadata' module_onboarding: type: boolean description: Is module onboarding execution default: false example: true moduleId: type: string description: The unique identifier for the associated module example: Occaecati officiis rerum neque. org: type: string example: Consequatur accusamus rem aliquam vitae. project: type: string example: Totam aspernatur. status: type: string description: The overall status of the execution example: Amet reiciendis totam temporibus aspernatur deleniti. description: ModuleExecutionResource is the representation for a single module execution. example: account: Est mollitia officiis quo aut quidem. created: 5454402981113289000 metadata: pipeline: Quidem est impedit alias aut eaque. pipeline_execution_id: Aliquid perspiciatis. pipeline_execution_number: Error totam quae. pipeline_name: Quos eum sunt eum. pipeline_stage_id: Ab temporibus dolores tempora maxime. trigger: Voluptas cum.: Qui numquam. module_onboarding: false moduleId: Ipsa iusto eaque quisquam qui. org: Aliquam qui ratione quia voluptatem cum. project: Error facilis corrupti totam debitis officiis facere. status: Dolorem molestiae recusandae ipsum est ex. required: - org - project - status - created - account - pipeline_org - pipeline_project - pipelineExecutionId - pipelineStageId - moduleId - pipeline DependenciesMetadata: type: object properties: dependency_name: type: string description: Dependency name example: Et nam expedita natus quis eius voluptatem. dependency_source: type: string description: Dependency source example: Nihil minima. dependency_version: type: string description: Dependency version example: Impedit sunt dolor sapiente impedit ab suscipit. example: dependency_name: Ex possimus et aut. dependency_source: Dolor omnis odit autem voluptate voluptatem iusto. dependency_version: Quos voluptatem dolorem quia dolor. VariableMetadata: type: object properties: variable_default: type: string description: Variable default value example: Nisi impedit hic necessitatibus et est blanditiis. variable_description: type: string description: Variable description example: Quidem expedita mollitia. variable_name: type: string description: Variable name example: Omnis et ipsa. variable_required: type: boolean description: Is variable required example: false variable_sensitive: type: boolean description: Is variable sensitive example: true variable_type: type: string description: Variable type example: Harum atque. example: variable_default: Architecto corporis. variable_description: Sed dolor vero ab non sit. variable_name: Omnis laborum ducimus. variable_required: true variable_sensitive: true variable_type: Voluptatem voluptatem aut. BatchCheckModuleLifecycleRequest: type: object properties: items: type: array items: $ref: '#/components/schemas/ModuleLifecycleBatchCheckItem' description: List of modules to check example: - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 maxItems: 1000 example: items: - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 - name: o3 namespace: k system: t version: 7p0 required: - items ModuleRegistryCreateModuleResponseBody: type: object properties: account: type: string description: Harness account ID that owns the module. example: abc123DEFghiJKL minLength: 1 maxLength: 128 created: type: integer description: Created is the unix timestamp at which the resource was originally created in milliseconds. example: 5974615396804364000 format: int64 description: type: string description: Free-form text describing the purpose and usage of the module. example: Provisions a VPC with public and private subnets. id: type: string description: module id example: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff name: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 org: type: string description: Organization identifier where the Git connector is defined. Defaults to scope_org if not provided. example: my_org maxLength: 1024 project: type: string description: Project identifier where the Git connector is defined. Defaults to scope_project if not provided. example: my_project maxLength: 1024 repository: type: string description: Name of the Git repository that contains the module source code. example: my-terraform-modules repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source. example: my_github_connector repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' scope_org: type: string description: Organization identifier where the module is scoped. example: my_org maxLength: 1024 scope_project: type: string description: Project identifier where the module is scoped. example: my_project maxLength: 1024 storage_type: type: string description: Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files. default: git_reference example: git_reference enum: - git_reference - artifact system: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 tags: type: string description: Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws). example: Quibusdam sunt aperiam tempore alias sit adipisci. updated: type: integer description: Modified is the unix timestamp at which the resource was last modified in milliseconds. example: 8323453498009981000 format: int64 description: Create-ModuleResponseBody result type (default view) example: account: abc123DEFghiJKL created: 8096909357996544000 description: Provisions a VPC with public and private subnets. id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff name: my-vpc-module org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' scope_org: my_org scope_project: my_project storage_type: artifact system: aws tags: Et nesciunt numquam quo impedit. updated: 6544535712321405000 required: - account - name - system - id - created - updated CreateModuleDataRequest: type: object properties: download_url: type: string description: download url of the module example: Qui maiores. error: type: object description: error from the tag operation example: Voluptatem vero quidem non accusamus vero earum.: Omnis laudantium voluptates excepturi tempore et qui. additionalProperties: type: string example: Porro sit cumque sint asperiores necessitatibus. examples_paths: type: array items: type: string example: Occaecati commodi sapiente odio autem iste. description: path of the examples relative to the module example: - Sed velit temporibus mollitia aliquam. - Et quidem. - Explicabo corporis sapiente vero. git_tag: type: string description: git tag of the module example: Fugiat ut quo rerum. metadata: type: string description: metadata to be parsed example: Quaerat laboriosam dolorum omnis quas et non. repo_url: type: string description: url pointing to the repo example: Tenetur quo veritatis placeat quis dicta. submodule_name: type: string description: name of the submodule been processed example: Explicabo alias. submodule_paths: type: array items: type: string example: Earum et rerum. description: path of the submodules relative to the module example: - Praesentium sapiente enim. - Occaecati et minima placeat nihil vitae beatae. - Quisquam vitae earum consequatur aut voluptas. - Nulla nesciunt ut accusantium. example: download_url: Repudiandae eligendi. error: Expedita maiores cupiditate magni eos.: Ut consequatur eos velit molestiae. Incidunt doloremque.: Sint et eum in et aut corporis. Quia quis.: Consequuntur voluptatem aperiam a. examples_paths: - Veniam voluptatem maiores magni. - Cumque vitae. git_tag: Possimus autem nulla omnis vero ut corporis. metadata: Harum quia quo ipsam in. repo_url: Error voluptates quo ipsam deleniti. submodule_name: Consectetur velit sed sequi porro. submodule_paths: - Sit nihil perferendis et quia. - Aliquid sit. - Distinctio nobis. - Minima totam velit dolor. required: - metadata - download_url - git_tag GetModuleLifecycleVersionStatusResponse: type: object properties: action: type: string description: Enforcement action derived from the tier's rule action example: fail enum: - no_action - warn - fail minimum_supported_version: type: string description: The lowest-numbered version currently in the supported tier example: Atque dolorem doloremque et in. tier: type: string description: 'Lifecycle tier: supported, warning, or deprecated' example: deprecated enum: - supported - warning - deprecated example: action: warn minimum_supported_version: Necessitatibus aut iste exercitationem cupiditate. tier: supported required: - tier - action ResourceMetadata: type: object properties: resource_name: type: string description: Resource name example: Dolores deserunt veniam ut libero sunt. resource_type: type: string description: Resource type example: Veniam perspiciatis eos non fugiat illo commodi. example: resource_name: Inventore minima amet soluta corrupti occaecati praesentium. resource_type: Ab quod nesciunt voluptate dolores dolor mollitia. ListModuleVersionsResponse: type: object properties: modules: type: array items: $ref: '#/components/schemas/HarnessIacmModuleRegistryVersions' description: list of versions for a given module example: - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. example: modules: - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - versions: - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. - git_version: Doloremque et et recusandae. module_version: Et voluptatum iure eum debitis sunt. required: - modules CreateModuleTagsRequest: type: object properties: error: type: object description: error from the tag operation example: Tempore repellat et quia explicabo quasi.: Magnam debitis harum autem iusto. additionalProperties: type: string example: Et sunt. tags: type: array items: type: string example: Ut fugit expedita error quia dolor error. description: tags defining the module example: - Necessitatibus reiciendis unde. - Aut et vel id quo. - A eligendi sapiente vero. example: error: Ipsam culpa reiciendis ab.: Sed voluptatem unde suscipit. Voluptate iure qui inventore sunt reiciendis illum.: Rem consequatur id. tags: - Esse atque dignissimos non. - Officia sunt. - Omnis inventore sit deleniti doloremque. - Aut illo est ex et sit qui. OutputMetadata: type: object properties: output_description: type: string description: Output description example: Suscipit fugit sed sint. output_name: type: string description: Output name example: Consectetur distinctio rerum hic sunt. output_sensitive: type: boolean description: Output sensitivity example: true example: output_description: Dolores officiis. output_name: Quo accusantium vitae quos ipsum sint voluptas. output_sensitive: false ModuleResourceCollection: type: array items: $ref: '#/components/schemas/ModuleResource' description: ModuleResourceCollection is the result type for an array of ModuleResource (default view) example: - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. - account: abc123DEFghiJKL created: 2016138915894156800 description: Provisions a VPC with public and private subnets. domain_prefix: Illo velit quibusdam velit iste repudiandae perferendis. git_tag_style: module-name-* id: aaaaaaaa-bbbb-cccc-eeee-ffffffffffff module_error: Aut incidunt maiores quam. name: my-vpc-module namespace: Aut et dolores. onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: true org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' repository_url: Et et doloribus ullam. scope_org: my_org scope_project: my_project storage_type: artifact synced: 8344366690986247000 system: aws tags: Esse dolor eligendi reprehenderit. testing_enabled: false testing_metadata: account: 6bi org: 6w5 pipelines: - Maxime eius vel in maxime et ad. - Quia ipsum voluptas reprehenderit dolores ea mollitia. - Nostrum dolore est sit ut. - Accusamus beatae fuga consequatur officiis exercitationem. project: 3xt provider_connector: Tempora expedita hic omnis sapiente itaque qui. provisioner_type: Et ipsum necessitatibus eos. provisioner_version: Expedita est maxime ut explicabo. release_pipeline: Quibusdam soluta dicta. updated: 2045512812616660500 version_statuses: Id tempore repudiandae.: Qui qui deserunt et aut. Quasi quos neque vitae sunt enim quod.: Aut aut et eligendi explicabo repellendus harum. versions: - Aut illo omnis quibusdam. - Omnis eligendi unde. - Maiores omnis blanditiis explicabo voluptates totam. - A sunt vel. ExampleTreeItem: type: object properties: content_type: type: string description: kind of entry example: directory enum: - file - directory name: type: string description: leaf name of the entry (no path separators) example: Placeat quo omnis ut. path: type: string description: full relative path from the module root, forward-slash separated example: Deleniti expedita in reprehenderit quas. example: content_type: file name: Ut ut animi rerum sint ipsum. path: Debitis ea ut quia facere. required: - name - path - content_type BatchCheckModuleLifecycleResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/ModuleLifecycleBatchCheckResult' description: Lifecycle violations found; items with no rule or supported tier are omitted example: - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. example: results: - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. - action: warn minimum_supported_version: Molestiae sunt. name: Ut fugiat molestiae omnis. namespace: Velit modi omnis mollitia nostrum qui. system: Et magnam rerum eum ab inventore dolor. tier: warning version: Consequatur earum fuga veritatis sapiente. required: - results CreateModuleRequest: type: object properties: description: type: string description: Free-form text describing the purpose and usage of the module. example: Provisions a VPC with public and private subnets. git_tag_style: type: string description: Pattern used to match Git tags for module versioning. Use 'module-name-*' to match tags like 'my-vpc-module-v1.0.0'. example: module-name-* name: type: string description: Human-readable name of the module. Must be unique within the same scope and system. example: my-vpc-module minLength: 1 maxLength: 128 onboarding_pipeline: type: string description: Identifier of the Harness pipeline used for module onboarding and metadata sync. example: Module_Onboarding_Pipeline onboarding_pipeline_org: type: string description: Organization where the onboarding pipeline is defined. Defaults to scope_org if not provided. example: my_org onboarding_pipeline_project: type: string description: Project where the onboarding pipeline is defined. Defaults to scope_project if not provided. example: my_project onboarding_pipeline_sync: type: boolean description: When true, module metadata is automatically synced via the onboarding pipeline when new Git tags are pushed. default: false example: false org: type: string description: Organization identifier where the Git connector is defined. Defaults to scope_org if not provided. example: my_org maxLength: 1024 project: type: string description: Project identifier where the Git connector is defined. Defaults to scope_project if not provided. example: my_project maxLength: 1024 repository: type: string description: Name of the Git repository that contains the module source code. example: my-terraform-modules repository_branch: type: string description: Repository Branch in which the code should be accessed. example: main repository_commit: type: string description: Repository Commit/Tag in which the code should be accessed. example: abc10ed repository_connector: type: string description: Harness Git connector identifier used to access the Git repository. Must reference a valid Git connector in your account. Leave empty when using Harness Code as the repository source. example: my_github_connector repository_path: type: string description: Repository Path is the path in which the infra code resides. default: '' example: '' storage_type: type: string description: Defines how module versions are stored. 'git_reference' resolves versions from Git tags; 'artifact' stores uploaded archive files. default: git_reference example: git_reference enum: - git_reference - artifact system: type: string description: Provider or system the module targets. Lowercase letters only (e.g. aws, gcp, azure, kubernetes). example: aws pattern: ^[a-z]+$ minLength: 1 maxLength: 128 tags: type: string description: Comma-separated list of tags to categorize the module (e.g. networking,vpc,aws). example: Repellendus quia. example: description: Provisions a VPC with public and private subnets. git_tag_style: module-name-* name: my-vpc-module onboarding_pipeline: Module_Onboarding_Pipeline onboarding_pipeline_org: my_org onboarding_pipeline_project: my_project onboarding_pipeline_sync: false org: my_org project: my_project repository: my-terraform-modules repository_branch: main repository_commit: abc10ed repository_connector: my_github_connector repository_path: '' storage_type: git_reference system: aws tags: Voluptas ad inventore facere quis sit. required: - name - system UpdateTestingRequest: type: object properties: pipeline_id: type: array items: type: string example: Itaque eum eum. description: pipelines to create the webhooks to trigger the executions for testing example: - Velit incidunt. - Autem et dignissimos aperiam. - Odio ipsam sint aspernatur quis. - Nemo sapiente eaque aut aperiam in quibusdam. pipeline_org: type: string description: pipeline org example: Voluptas magni. pipeline_project: type: string description: pipeline project example: Aut et quisquam beatae. provider_connector: type: string description: provider connector default: '' example: Est rem. provisioner_type: type: string description: provisioner type example: Est a. provisioner_version: type: string description: provisioner version example: Nobis voluptatum autem officia ut ab. release_pipeline: type: string description: pipeline to create the webhooks for releases example: Perspiciatis aliquam sed culpa fugiat corrupti. example: pipeline_id: - Et quisquam animi velit laboriosam soluta. - Dolor blanditiis impedit. pipeline_org: Maiores nisi dolor aut et voluptas voluptas. pipeline_project: Omnis et facere repellat enim. provider_connector: Sapiente ea. provisioner_type: Autem repudiandae ratione. provisioner_version: Eum ut suscipit libero minus sit dignissimos. release_pipeline: Exercitationem sit. required: - provisioner_type - provisioner_version - pipeline_org - pipeline_project CreateTestingPipelineRequest: type: object properties: pipeline_org: type: string description: pipeline org example: Laboriosam temporibus natus incidunt. pipeline_project: type: string description: pipeline project example: Sit dolores dolor. type: type: string description: type of the pipeline to create default: test example: Ut possimus. example: pipeline_org: Pariatur est ex voluptates. pipeline_project: Expedita quidem laboriosam eos. type: Eveniet et quia debitis voluptates qui. required: - pipeline_org - pipeline_project ModuleLifecycleBatchCheckItem: type: object properties: name: type: string description: Module name example: f minLength: 1 namespace: type: string description: Encoded namespace identifying the module scope example: 0ox minLength: 1 system: type: string description: Module system (provider) example: fd minLength: 1 version: type: string description: Module version to check example: h minLength: 1 description: A single module item to check lifecycle status for example: name: 58e namespace: d system: m version: '4' required: - namespace - name - system - version ModuleLifecycleBatchCheckResult: type: object properties: action: type: string description: Enforcement action for the tier example: warn enum: - no_action - warn - fail minimum_supported_version: type: string description: The lowest-numbered version currently in the supported tier example: Rem in fuga et inventore. name: type: string description: Module name example: Vel maxime illo nihil accusantium cum. namespace: type: string description: Encoded namespace identifying the module scope example: Optio natus. system: type: string description: Module system (provider) example: Expedita qui sequi qui eos. tier: type: string description: 'Lifecycle tier: warning or deprecated' example: warning enum: - warning - deprecated version: type: string description: Module version example: Reprehenderit sint aspernatur animi rerum animi. description: Lifecycle check result for a single module item example: action: warn minimum_supported_version: At officia repellendus ut unde laudantium aut. name: Distinctio qui occaecati cum sint neque laborum. namespace: Et deserunt itaque aut voluptate impedit quas. system: Recusandae culpa mollitia sequi. tier: warning version: Libero tempora quo deserunt. required: - namespace - name - system - version - tier - action ListModuleMetadataResponse: type: object properties: account: type: string description: account name example: Saepe provident omnis necessitatibus ut. dependencies: type: array items: $ref: '#/components/schemas/DependenciesMetadata' description: Dependencies of the module example: - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. examples_paths: type: array items: type: string example: Voluptas aut reprehenderit voluptas aliquam illo. description: Example directories discovered for this module version example: - Eius dolores sed quia alias. - Voluptas voluptates. - Praesentium soluta. metadata_error: type: string description: error while retrieving the module example: Velit ipsam sapiente sed consequatur. module_version: type: string description: module version example: Maxime corporis est maxime tempore est. name: type: string description: module name example: A quibusdam voluptas inventore consequatur est et. outputs: type: array items: $ref: '#/components/schemas/OutputMetadata' description: Outputs of the module example: - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true providers: type: array items: $ref: '#/components/schemas/ProviderMetadata' description: Providers of the module example: - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. resources: type: array items: $ref: '#/components/schemas/ResourceMetadata' description: Resources of the module example: - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. scope_org: type: string description: org name example: Qui eveniet. scope_project: type: string description: project name example: Est eum ut. submodule: type: array items: type: string example: Debitis excepturi consequatur ut labore repellat. description: Submodules of the module example: - Ut et. - Voluptates nesciunt sint nostrum tempora iure. system: type: string description: system name example: Repellat necessitatibus in placeat dolorem. variables: type: array items: $ref: '#/components/schemas/VariableMetadata' description: Variables of the module example: - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. example: account: In accusamus animi. dependencies: - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. - dependency_name: Deleniti hic sapiente dolor commodi nesciunt. dependency_source: Et aut qui id. dependency_version: Modi quo quis. examples_paths: - Tempora fugit. - Molestias in velit nesciunt non debitis harum. - Voluptatibus assumenda maiores. metadata_error: A aspernatur asperiores. module_version: Enim voluptatem at fugiat excepturi. name: A dolorem. outputs: - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true - output_description: Sint aliquam id sed. output_name: Illum eligendi nesciunt labore aut magnam saepe. output_sensitive: true providers: - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. - provider_name: Quisquam culpa. provider_source: Aliquid autem quam consequatur. provider_version: Reiciendis repellat consequatur. resources: - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. - resource_name: Doloribus omnis eum. resource_type: Id suscipit vel praesentium velit. scope_org: Repellendus et est. scope_project: Sint facilis odio aut. submodule: - Nesciunt nulla perferendis. - Excepturi officiis provident ea inventore corporis. - Dolorem sint ut quos. system: Et eius sit consequuntur commodi iste. variables: - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. - variable_default: Quae totam enim. variable_description: Placeat corporis. variable_name: Repellat voluptatum rerum pariatur nisi consequuntur. variable_required: true variable_sensitive: false variable_type: Vitae minus. required: - account - name - system - module_version - outputs - providers - resources - variables securitySchemes: x-api-key: name: x-api-key type: apiKey in: header description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint. externalDocs: description: Find out more about Swagger url: http://swagger.io x-stoplight: id: oc91t4vrfnjyi x-tagGroups: - name: Organizations tags: - Organization - name: Projects tags: - Org Project - Project - name: Secrets tags: - Account Secret - Org Secret - Project Secret - Secrets - name: Connectors tags: - Account Connector - Org Connector - Project Connector - Connectors - GoogleSecretManagerConnector - name: Roles tags: - Account Roles - Organization Roles - Project Roles - Roles - name: Resource Groups tags: - Account Resource Groups - Organization Resource Groups - Project Resource Groups - Filter Resource Groups - Harness Resource Group - Zendesk - name: Role Assignments tags: - Account Role Assignments - Org Role Assignments - Project Role Assignments - Role Assignments - name: Platform tags: - Access Control List - Account Banner - Account Banner - Account Licensed Modules - Account License Type - Account Webhooks - AccountSetting - Accounts - Analyze Account Access Policy - Analyze Organization Access Policy - Analyze Project Access Policy - ApiKey - Audit - AuditFilters - Authentication Settings - Canny - Devops Essentials License Data By Account - EULA - Filter - Harness Resource Type - Invite - IP Allowlist - Nextgen Ldap - Notification Channels - Notification Rules - OIDC - Oidc-Access-Token - Oidc-ID-Token - Org Webhooks - Permissions - Project Webhooks - Secret Managers - Service Account - Setting - SMTP - Source Code Manager - Token - User - User Group - Variables - name: Delegate tags: - Agent mTLS Endpoint Management - Delegate Download Resource - Delegate Group Tags Resource - Delegate Setup Resource - Delegate Token Resource - name: Pipelines tags: - Pipelines - Input Sets - Approvals - Pipeline Execution - Pipeline Dashboard - Pipeline Input Set - Pipeline - Pipeline Execution Details - Pipeline Execute - Pipeline Refresh - Pipeline data retention - Triggers - TriggersEvents - Webhook Triggers - Webhook Event Handler - DryRunPipeline - name: Artifact Registry tags: - Registries - Artifacts - Docker Artifacts - Helm Artifacts - quarantine - Webhooks - Spaces - Replication - Registry V3 - Registries - Registry V3 - Packages - Registry V3 - Versions - Registry V3 - Files - Registry V3 - Metadata - Registry V3 - Firewall - Registry V3 - Transfer - name: Database DevOps tags: - Database Schema - Database Instance - Deployed State - Execution Config - Migration State - name: CD tags: - K8s Release Service Mapping - CustomDeployment - Environments - EnvironmentGroup - Infrastructures - Usage - File Store - Service Dashboard - ServiceOverrides - Rollback - tas - name: Deployment Freeze tags: - Freeze CRUD - Freeze Evaluation - Freeze Schema - name: Services tags: - Account Services - Org Services - Project Services - Services - name: Rancher Infrastructures tags: - Account Rancher Infrastructure - Org Rancher Infrastructure - Project Rancher Infrastructure - name: Templates tags: - Account Template - Org Template - Project Template - Templates - Global Templates - name: GitOps tags: - Agents - Application - Applications - Certificates - Clusters - Dashboard Aggregates - Dashboards - GnuPGP Keys - GPG Keys - Hosts - Project mappings - Projects - Reconciler - Repositories - Repository Certificates - Repository credentials - ValidateHost - name: GitX tags: - GitX Webhooks - Org Gitx Webhooks - Project Gitx Webhooks - name: CACM tags: - Anomalies Ignorelist Rule - Anomalies - BI Dashboards - Budgets - Budget Groups - Cost Categories - Cloud Accounts - K8S Connectors Metadata - Notification Settings v2 - Overview - Data Job Status - Recommendation cost settings - Unit Metric - Anomaly Comments - Cloud and AI cost anomaly details - Cloud and AI cost anomalies v2 - Cost Details - Currency Preferences - External Data Provider - AiEngine - CACM governance cost settings - Governance Enforcement Recommendation APIs - Governance Alert - Governance Overview - Governance Recommendation APIs - RuleEnforcement - Rule Executions - Rule - Rule Sets - Perspectives Folders - Perspective Reports - Perspectives - Cost Category Jira Project Mapping - Recommendations Details - Recommendations - Recommendation Jira - Recommendation Preferences - Recommendation Presets - Recommendation Servicenow - Recommendation Tags - Recommendation Ignore List - AutoStopping Rules - AutoStopping Rules V2 - AutoStopping Load Balancers - AutoStopping Fixed Schedules - AutoStopping Alerts - Commitment Orchestrator Events APIs - name: Feature Flags tags: - API Keys - Feature Flags - Targets - Target Groups - Environment Perspectives - Anomalies - Proxy - Tags - name: SRM tags: - Monitored Services - SLOs dashboard - NG SLOs - SLOs - Downtime - Srm Notification - name: Internal Developer Portal - IDP tags: - Entities - Teams - CatalogCustomProperties - Scores - DataSource - KubernetesDataPoints - AggregationRules - AppConfig - PluginInfo - LayoutProxy - Kinds - LayoutsV3 - LayoutsV4 - name: Environment Management - IDP tags: - Environment - Infrastructure - Instance - name: Custom Dashboards tags: - aida - dashboards - downloads - embed - folders - name: Policy Management tags: - dashboard - examples - policies - evaluate - evaluations - policysets - system - name: Code tags: - repository - status_checks - pullreq - upload - webhook - resource - rules - labels - name: IaCM tags: - usage - approvals - costs - executions - module-registry - workspaces - settings - tf-standard-backend - variables - name: STO tags: - Exemptions - Issues - Scans - Products - Test Targets - Target Variants - name: SEI tags: - Collection categories - Collections - Contributors - DORA - name: Git Sync (deprecated) tags: - Git Branches - Git Full Sync - Git Sync Settings - Git Sync - Git Sync Errors - name: Error Models tags: - Error Response - Governance Metadata - name: Supply Chain Security tags: - integration - PipelineInfraConfig - SBOM - Integration Step Config - Delete Step Config - Delete Repositories - Pipeline Store Config - Evidence Vault [Beta] - name: Release Management tags: - Release Groups - Releases - Orchestration Processes - Orchestration Activities - Orchestration Executions - Conflicts - Freeze - Reports - Uploads - name: Resilience Testing tags: - Actions - Action Templates - Chaos Components - Chaos Hubs - ChaosGuard Conditions - ChaosGuard Rules - DR Tests - Experiments - Experiment Templates - Faults - Fault Templates - Chaos Infrastructure - Health - Network Maps - Onboarding - Probes - Probe Templates - Chaos Recommendations - Risks