GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves clusters associated with a specific GitLab group by making an API call to the GitLab endpoint `/api/v4/groups/{id}/clusters`. It is useful for scenarios where users need to list or manage Kubernetes clusters linked to a GitLab group, such as monitoring cluster status or automating cluster-related workflows.

Use Case Examples

  1. Fetching all clusters for a GitLab group to display in a dashboard.
  2. Automating the retrieval of cluster information for integration with other DevOps tools.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for 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 to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Path parameters required for the API endpoint, specifically the group ID.

Output

JSON

  • clusters - Array of cluster objects associated with the specified GitLab group.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID path parameter is correctly set and not empty to avoid 404 errors.
  • Verify that the API authentication token is valid and has sufficient permissions to access group clusters.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion