GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation fetches certificate-based clusters within a specified group hierarchy from the GitLab API. It is useful for users who want to discover and manage Kubernetes clusters associated with a GitLab group, especially those authenticated via certificates. For example, a DevOps engineer can use this to automate the retrieval of cluster information for monitoring or deployment purposes.

Use Case Examples

  1. Retrieve all certificate-based clusters for a specific GitLab group by providing the group ID as a query parameter.
  2. Use the node to integrate cluster discovery into CI/CD pipelines for automated cluster management.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Collection of query parameters for the API request, including the required group_id to specify the GitLab group.

Output

JSON

  • clusters - List of certificate-based clusters discovered in the specified group hierarchy
  • metadata - Additional metadata about the API response, such as pagination or status information

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group_id query parameter is provided and is a valid integer; missing or invalid group_id will cause the API request to fail.
  • If skipping authentication, verify that the GitLab instance allows unauthenticated access to the endpoint; otherwise, authentication errors will occur.
  • Check the baseUrl to ensure it points to a valid GitLab instance; incorrect URLs will result in connection errors.
  • Common error messages include 401 Unauthorized (due to missing or invalid API key) and 404 Not Found (if the group_id does not exist or the endpoint path is incorrect).

Links

Discussion