GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the cluster agents associated with a specific project in GitLab using the GitLab API. It is useful for scenarios where you need to manage or monitor cluster agents linked to a project, such as in DevOps workflows or infrastructure automation.

Use Case Examples

  1. Fetch all cluster agents for a given project ID to display in a dashboard.
  2. Automate the retrieval of cluster agents to integrate with other CI/CD tools.

Properties

Name Meaning
Skip Authentication Determines whether to skip 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 request is sent.
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 parameters required for the API endpoint, specifically the project ID or URL-encoded path.

Output

JSON

  • id - The unique identifier of the cluster agent.
  • name - The name of the cluster agent.
  • description - Description of the cluster agent.
  • created_at - Timestamp when the cluster agent was created.
  • updated_at - Timestamp when the cluster agent was last updated.
  • config - Configuration details of the cluster agent.

Dependencies

  • GitLab API key credential

Troubleshooting

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

Links

Discussion