GitLab API

GitlabTool
Join our community

Actions905

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 by providing the project ID to monitor Kubernetes environments.
  2. Automate retrieval of cluster information to integrate with other CI/CD workflows.

Properties

Name Meaning
Skip Authentication If set to true, the node skips 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 to control pagination of the results.
Path Parameters Path parameters required for the API endpoint, specifically the project ID or URL-encoded path.

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
    • 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.
  • If authentication is skipped, the API may reject the request or return limited data depending on GitLab's access policies.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause errors or unexpected results.

Links

Discussion