GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node operation allows users to download a specific version of a Terraform module from the GitLab Terraform Registry. It is useful for automating the retrieval of Terraform modules by specifying the module's namespace, name, system, and version. Practical applications include integrating Terraform module downloads into CI/CD pipelines or infrastructure automation workflows.

Use Case Examples

  1. Download a specific version of a Terraform module by providing the module namespace, name, system, and version to automate infrastructure provisioning.
  2. Use the node to fetch Terraform modules dynamically during deployment processes to ensure the correct module version is used.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL for the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the required path and query parameters for the API call, including module_namespace, module_name, module_system, and module_version.
Request Body Schema Defines the request body schema, which is null for this operation.
Request Path The API endpoint path template for downloading the Terraform module version.
Query Parameters Collection of query parameters, specifically module_version to specify the version of the module to download.
Path Parameters Collection of path parameters including module_namespace (group's ID or slug), module_name, and module_system to identify the module.

Output

JSON

  • downloadUrl - The URL to download the specified Terraform module version.
  • statusCode - HTTP status code of the API response.
  • headers - HTTP headers returned by the API response.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure that the module_namespace, module_name, module_system, and module_version parameters are correctly specified; missing or incorrect values will cause the API call to fail.
  • Authentication errors may occur if the GitLab API token is invalid or missing; verify the token and permissions.
  • Network issues or incorrect baseUrl can prevent successful API calls; confirm the baseUrl is correct and accessible.

Links

Discussion