GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves information about a specific Terraform module from the GitLab Terraform Registry API (v4). It is useful for users who want to programmatically access details about Terraform modules hosted on GitLab, such as module metadata or versioning information. For example, DevOps engineers can automate fetching module details to integrate with CI/CD pipelines or infrastructure management tools.

Use Case Examples

  1. Fetch details of a Terraform module by specifying its namespace, name, and system to automate infrastructure provisioning workflows.
  2. Integrate with GitLab Terraform Registry to validate module existence and metadata before deployment.

Properties

Name Meaning
Skip Authentication Option to bypass authentication when making the API request.
Authentication Type of authentication used for the API request, hidden unless Skip Authentication is false.
baseUrl Base URL of the GitLab instance to send the API request to, defaulting to https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters required in the API request path to specify the Terraform module.

Output

JSON

  • response - The JSON response from the GitLab Terraform Registry API containing details about the specified Terraform module.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the module_namespace, module_name, and module_system path parameters are correctly specified; otherwise, the API request will fail with a 404 or 400 error.
  • If authentication is required and not provided or invalid, the API will return a 401 Unauthorized error. Verify the GitLab API key credential is correctly configured.
  • Network or baseUrl misconfiguration can cause connection errors; ensure the baseUrl is correct and reachable.

Links

Discussion