GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves the list of clusters associated with a specific project in GitLab using the GitLab API v4. It is useful for users who want to manage or monitor Kubernetes clusters linked to their GitLab projects. For example, a DevOps engineer might use this node to fetch cluster details for automation or reporting purposes.

Use Case Examples

  1. Fetch clusters for a project with ID '123' to monitor their status.
  2. Retrieve paginated cluster data for a project to integrate with a dashboard.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API 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 requests are sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters for pagination, including 'page' (current page number) and 'per_page' (number of items per page).
Path Parameters Path parameter 'id' representing the ID or URL-encoded path of the GitLab project whose clusters are being retrieved.

Output

JSON

  • clusters - Array of cluster objects associated with the specified project
  • pagination
    • page - Current page number of the results
    • per_page - Number of items per page in the results
    • total - Total number of clusters available

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Check that the GitLab API base URL is correct, especially if using a self-hosted GitLab instance.
  • Verify that the API key credential has sufficient permissions to read cluster information for the project.
  • If pagination parameters are used, ensure they are valid integers to avoid API errors.

Links

Discussion