GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a specific cluster within a GitLab group using the GitLab API. It is useful for managing and modifying cluster configurations associated with a group in GitLab, such as updating cluster details or settings. For example, a DevOps engineer might use this node to update the configuration of a Kubernetes cluster linked to a GitLab group.

Use Case Examples

  1. Updating cluster configuration for a GitLab group to change its settings or metadata.
  2. Modifying cluster details to reflect new infrastructure changes within a GitLab group.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used for the request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but PUT is used for this operation.
Path Parameters Parameters for the API path including the group ID and cluster ID to identify the cluster to update.

Output

JSON

  • id - The unique identifier of the updated cluster.
  • name - The name of the updated 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 after update.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID and cluster ID path parameters are correctly set; incorrect IDs will cause API errors.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify credentials.
  • The API endpoint requires a valid request body matching the cluster update schema; malformed or incomplete data will cause request failures.

Links

Discussion