GitLab API

GitlabTool

Actions1095

Terraform_registry → getApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystem

AI-generated

Summary

Retrieve specific Terraform module information from a GitLab project's Terraform registry by specifying the project ID or full path, module name, and module system via the API endpoint.

Inputs

  • id (required) — The ID or full path of the GitLab project containing the Terraform module.
  • module_name (required) — The name of the Terraform module to retrieve information for.
  • module_system (required) — The module system (provider) of the Terraform module, e.g., 'aws'.
  • terraform-get — Optional query parameter 'terraform-get' which can be set to '1' to enable Terraform get redirection behavior.
  • skipAuthentication — Boolean flag to skip authenticating the request, defaults to false, meaning authentication via GitLab API credential is normally required.

Output shape

a single Terraform module object containing details as returned by the GitLab API for the specified project ID, module name, and module system.

The operation sends a GET request to the path /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system} using the GitLab API credentials unless authentication is skipped. The optional 'terraform-get' query parameter can affect the returned data. No pagination applies as the response is for a specific module.

Links

Discussion