GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific cluster within a GitLab group by making a GET request to the GitLab API endpoint `/api/v4/groups/{id}/clusters/{cluster_id}`. It is useful for users who want to fetch information about a particular cluster associated with a group in GitLab, such as for monitoring or managing cluster configurations.

Use Case Examples

  1. Fetch details of a cluster with ID 123 in group with ID 'my-group' to monitor cluster status.
  2. Retrieve cluster information to integrate with other automation workflows that manage GitLab group resources.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Selects the authentication method to use 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, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters Parameters used to specify the group ID and cluster ID in the API request path.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • environment_scope - The environment scope associated with 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; incorrect IDs will result in 404 Not Found errors.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access group clusters.
  • Check the baseUrl property if using a self-hosted GitLab instance to ensure the URL is correct and accessible.

Links

Discussion