GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 hosted on GitLab, such as module namespace, name, and system type.

Use Case Examples

  1. A DevOps engineer automates infrastructure deployment and needs to fetch module details to verify version compatibility.
  2. A CI/CD pipeline step that validates the existence and metadata of a Terraform module before applying infrastructure changes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use if authentication is not skipped.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request.
Path Parameters Parameters used to specify the Terraform module to retrieve, including module namespace, module name, and module system.

Output

JSON

  • module_namespace - The namespace or group ID of the Terraform module.
  • module_name - The name of the Terraform module.
  • module_system - The system type of the Terraform module.
  • module_details - Detailed information about the Terraform module retrieved from the GitLab API.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the path parameters (module_namespace, module_name, module_system) are correctly set and valid to avoid 404 Not Found errors.
  • If authentication is required and skipped, the request may fail with authorization errors; ensure proper authentication is configured unless skipping is intentional.
  • Verify the baseUrl is correct and accessible to avoid connection errors.

Links

Discussion