GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves details of a specific cluster within a GitLab group using the GitLab API. It is useful for scenarios where you need to fetch cluster information for management, monitoring, or automation purposes within GitLab groups. For example, it can be used to get cluster status or configuration details for a given group and cluster ID.

Use Case Examples

  1. Fetch cluster details for a specific group in GitLab to monitor cluster health.
  2. Retrieve configuration information of a cluster to automate deployment or integration tasks.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, 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, default is GET.
Path Parameters Parameters used in the API request path to specify the group ID and cluster ID.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • environment_scope - The environment scope of the cluster.
  • platform_kubernetes_api_url - The Kubernetes API URL of the cluster.
  • 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 key credential for authentication

Troubleshooting

  • Ensure the group ID and cluster ID path parameters are correctly set and valid to avoid 404 Not Found errors.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions to access group clusters.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion