GitLab API

GitlabTool

Actions1095

Clusters → putApiV4ProjectsIdClustersClusterId

AI-generated

Summary

Update a specific cluster associated with a GitLab project by sending a PUT request to the GitLab API endpoint /api/v4/projects/{id}/clusters/{cluster_id}.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project whose cluster you want to update.
  • cluster_id (required) — The ID of the cluster within the specified project to update.
  • putApiV4ProjectsIdClustersClusterId (required) — An object containing the fields to update the cluster with, matching the GitLab API's expected request body schema for this endpoint.
  • baseUrl — Optional override for the GitLab API base URL, defaulting to https://gitlab.com.
  • skipAuthentication — Boolean flag to skip authentication if set to true; otherwise, GitLab API credentials are used.

Output shape

a single JSON object representing the updated cluster as returned by the GitLab API

Returns the updated cluster object from GitLab. The operation requires the project ID and cluster ID path parameters and a properly structured request body according to the GitLab API specification.

Examples

Example 1: Update cluster metadata or settings

Specify the project ID and cluster ID path parameters and provide the updated cluster properties in the request body to modify the cluster associated with the project.

Links

Discussion