GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves detailed information about a specific Terraform module from the GitLab Terraform Registry. It is useful for users who want to programmatically access metadata or details of a Terraform module identified by its namespace, name, and system type. For example, DevOps engineers can use this node to fetch module details to automate infrastructure provisioning workflows or validate module versions.

Use Case Examples

  1. Fetch details of a Terraform module by specifying its namespace, name, and system to integrate with CI/CD pipelines.
  2. Automate retrieval of Terraform module metadata for auditing or documentation purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use if authentication is not skipped.
baseUrl The base URL of the GitLab instance to send the API request to.
Method HTTP method to use for the API request.
Path Parameters Parameters to specify the Terraform module's namespace, name, and system type for the API request.

Output

JSON

  • id - Unique identifier of the Terraform module
  • name - Name of the Terraform module
  • namespace - Namespace or group the module belongs to
  • system - System type of the module
  • version - Version of the Terraform module
  • description - Description of the Terraform module
  • created_at - Timestamp when the module was created
  • updated_at - Timestamp when the module was last updated
  • downloads_count - Number of times the module has been downloaded

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the module_namespace, module_name, and module_system path parameters are correctly set; missing or incorrect values will cause the API request to fail.
  • If authentication is enabled, verify that the GitLab API token is valid and has sufficient permissions to access the Terraform Registry.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the URL is correct and accessible.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (module does not exist), and 400 Bad Request (invalid parameters). Resolving these involves correcting credentials, verifying module existence, and validating input parameters respectively.

Links

Discussion