GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves cluster agents associated with a specific project in GitLab using the GitLab API v4. It is useful for DevOps teams or developers who need to manage or monitor cluster agents linked to their projects in GitLab. For example, it can be used to fetch details about cluster agents for automation or reporting purposes.

Use Case Examples

  1. Fetch cluster agents for a project with ID '123' to monitor their status.
  2. Retrieve a paginated list of cluster agents for a project to integrate with a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl 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 such as page number and items per page.
Path Parameters Path parameters including the project ID or URL-encoded path to identify the project.

Output

JSON

  • cluster_agents - List of cluster agents 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 cluster agents available

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Verify that the base URL is correct and points to a valid GitLab instance.
  • Check that the API key credential has sufficient permissions to access cluster agents for the project.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion