GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves detailed information about a specific cluster in the GitLab Admin API (v4). It is useful for administrators who need to manage or monitor clusters within their GitLab instance. For example, an admin can use this node to fetch the status, configuration, or metadata of a particular cluster by providing its cluster ID.

Use Case Examples

  1. Fetch details of a cluster with ID 123 to check its current status and configuration.
  2. Use the node to automate monitoring of clusters by periodically retrieving their information.

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.
Path Parameters The path parameters for the API request, specifically the cluster ID to identify which cluster to retrieve.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • provider - The cloud or infrastructure provider of the cluster.
  • created_at - Timestamp when the cluster was created.
  • status - Current status of the cluster.
  • platform_kubernetes - Details about the Kubernetes platform of the cluster.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the cluster_id path parameter is provided and valid; missing or incorrect IDs will cause errors.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify credentials.
  • Network or baseUrl misconfiguration can lead to connection failures; confirm the baseUrl is correct and accessible.

Links

Discussion