GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the clusters associated with a specific project in GitLab using the GitLab API. It is useful for scenarios where you need to manage or monitor Kubernetes clusters linked to a GitLab project, such as fetching cluster details for deployment or integration purposes.

Use Case Examples

  1. Fetch all clusters for a project with ID '123' to display their status in a dashboard.
  2. Retrieve clusters with pagination to handle large sets of clusters efficiently.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters for pagination such as page number and items per page.
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 in the results
    • total - Total number of clusters available

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Check that the baseUrl is correctly set to the GitLab instance you are querying.
  • If skipping authentication, verify that the endpoint supports unauthenticated access, otherwise requests will fail.
  • Pagination parameters should be valid integers; invalid values may cause errors or unexpected results.

Links

Discussion