GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates an existing cluster in the GitLab Admin API by sending a PUT request to the endpoint `/api/v4/admin/clusters/{cluster_id}`. It is useful for administrators who need to modify cluster configurations programmatically, such as changing cluster details or settings within GitLab's admin interface.

Use Case Examples

  1. Updating cluster details by specifying the cluster ID and providing the updated cluster data in the request body.
  2. Automating cluster management tasks in GitLab through workflows that modify cluster configurations.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, which is PUT for this operation.
Path Parameters The path parameters for the request, specifically the cluster ID to identify which cluster to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the cluster, containing the updated cluster details.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the cluster_id path parameter is correctly provided and is a valid integer, as it is required for the request.
  • Verify that the authentication credentials for GitLab API are correctly configured and valid, especially if Skip Authentication is false.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the API returns an error, verify that the request body schema matches the expected structure for updating a cluster in GitLab Admin API.

Links

Discussion