GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches certificate-based clusters within a specified group hierarchy from the GitLab API. It is useful for users who need to discover and manage Kubernetes clusters associated with a GitLab group, especially in environments where certificate-based authentication is used for cluster access. For example, a DevOps engineer can use this node to automate the retrieval of all clusters under a particular group to monitor or configure them programmatically.

Use Case Examples

  1. Retrieve all certificate-based clusters for a specific GitLab group by providing the group ID as a query parameter.
  2. Automate cluster discovery in CI/CD pipelines to ensure the latest cluster information is always available.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Collection of query parameters for the API request, specifically the group_id which identifies the GitLab group to find certificate-based clusters within.

Output

JSON

  • clusters - Array of certificate-based clusters discovered within the specified group hierarchy.

Dependencies

  • Requires GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the group_id query parameter is provided and is a valid integer; otherwise, the API request will fail.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions to access cluster information.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion