GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves detailed information about a specific cluster in GitLab using the GitLab API. It is useful for administrators or developers who need to manage or monitor clusters within their GitLab environment. For example, it can be used to fetch the status or configuration details of a cluster by providing its unique cluster ID.

Use Case Examples

  1. Fetch details of a cluster with ID 12345 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 the authentication process for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API 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 required for the API request, specifically the cluster ID to identify the cluster.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • provider - The provider of the cluster.
  • created_at - The creation timestamp of the cluster.
  • updated_at - The last update timestamp of the cluster.
  • status - The current status of the cluster.
  • platform_kubernetes - Details about the Kubernetes platform of the cluster.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the cluster_id path parameter is provided and correctly formatted as a string or integer.
  • Verify that the GitLab API credentials are correctly configured and have the necessary permissions to access cluster information.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (due to invalid or missing credentials), 404 Not Found (if the cluster ID does not exist), and 400 Bad Request (if the cluster_id parameter is missing or malformed).

Links

Discussion