GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves information about a specific Terraform module from a GitLab project's Terraform registry using the GitLab API v4. It is useful for automating infrastructure management workflows by programmatically accessing Terraform module details stored in GitLab. For example, it can be used to fetch module metadata for deployment automation or auditing purposes.

Use Case Examples

  1. Fetch Terraform module details for a project to integrate with CI/CD pipelines.
  2. Retrieve module system information to validate infrastructure configurations.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, including the terraform-get flag to control Terraform get redirection.
Path Parameters Required path parameters identifying the project and module: project ID or full path, module name, and module system.

Output

JSON

  • id - The ID of the Terraform module.
  • name - The name of the Terraform module.
  • version - The version of the Terraform module.
  • description - Description of the Terraform module.
  • source - Source URL or location of the module.
  • system - The module system type, e.g., 'aws'.
  • created_at - Timestamp when the module was created.
  • updated_at - Timestamp when the module was last updated.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID or full path is correct and accessible with the provided credentials.
  • Verify that the module name and module system parameters are accurate and exist in the project.
  • Check network connectivity and baseUrl configuration if the API request fails.
  • If authentication is skipped, ensure the endpoint is publicly accessible or adjust settings accordingly.

Links

Discussion