GitLab API

GitlabTool
Join our community

Actions905

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 GitLab projects. For example, it can be used to list all cluster agents for a project to check their status or configuration.

Use Case Examples

  1. Retrieve cluster agents for a project with ID '123' to monitor their activity.
  2. Fetch cluster agents with pagination to handle large sets of agents efficiently.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project.

Output

JSON

  • ``
    • id - The unique identifier of each cluster agent.
    • name - The name of each cluster agent.
    • web_url - The web URL to access each cluster agent in GitLab.
    • created_at - The creation timestamp of each cluster agent.
    • updated_at - The last update timestamp of each cluster agent.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct to avoid 404 errors.
  • Check that the API key credential has sufficient permissions to access cluster agents.
  • Verify the base URL is correct if using a self-hosted GitLab instance.
  • Pagination parameters should be valid integers; otherwise, the API may return errors or unexpected results.

Links

Discussion