GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the Terraform state information for a specific project in GitLab using the GitLab API. It is useful for DevOps and infrastructure teams who manage Terraform states within GitLab projects, allowing them to programmatically access state details for automation or monitoring purposes. For example, it can be used to fetch the current Terraform state of a project to verify infrastructure status or to integrate with other CI/CD pipelines.

Use Case Examples

  1. Fetch Terraform state details for project ID '123' and state name 'production'.
  2. Automate monitoring of Terraform state changes by periodically retrieving state information.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters for the request, including Terraform state lock ID.
Path Parameters Required path parameters identifying the project and Terraform state name.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • name - The name of the Terraform state.
  • terraformStateData - The detailed Terraform state information retrieved from the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and Terraform state name are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key has sufficient permissions to access the project's Terraform state.
  • Check network connectivity and the base URL if using a self-hosted GitLab instance.
  • Common error messages include 404 Not Found if the project or state name does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion