GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves detailed information about a specific cluster in the GitLab Admin API (v4) by its cluster ID. 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 or configuration details of a particular cluster by providing its ID.

Use Case Examples

  1. Fetch details of cluster with ID 12345 to check its status and configuration.
  2. Retrieve cluster information to audit or update cluster settings.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET.
Path Parameters Parameters included in the API request path, specifically the cluster ID to identify the cluster to retrieve.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • provider - The provider of the cluster (e.g., AWS, GCP).
  • status - The current status of the cluster.
  • created_at - Timestamp when the cluster was created.
  • updated_at - Timestamp when the cluster was last updated.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

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

Links

Discussion