GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to retrieve detailed information about a specific cluster in the GitLab Admin Clusters resource. It is useful for administrators who need to manage or audit clusters within their GitLab instance. For example, an admin can use this node to fetch the configuration and status of a cluster by providing its cluster ID.

Use Case Examples

  1. Retrieve details of a cluster by specifying its cluster ID to monitor its status or configuration.
  2. Use in automation workflows to fetch cluster information for reporting or alerting purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the 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 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.
  • created_at - Timestamp when the cluster was created.
  • updated_at - Timestamp when the cluster was last updated.
  • 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 cluster_id will cause request failures.
  • Verify that the GitLab API key credential is correctly configured and has sufficient permissions to access admin cluster information.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion