GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a specific cluster in GitLab using the Admin Clusters API. It is useful for administrators who need to modify cluster details such as configuration or metadata by specifying the cluster ID and providing the updated data in the request body. For example, an admin can update cluster settings to reflect changes in infrastructure or permissions.

Use Case Examples

  1. Updating a cluster's configuration by providing the cluster ID and new settings in the request body.
  2. Modifying cluster metadata for administrative purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip API 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 API request is sent.
Method HTTP method to use for the API request, defaulting to GET but can be set to PUT for this operation.
Path Parameters Parameters to be included in the API request path, specifically the cluster ID to identify which cluster to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the cluster.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the cluster_id path parameter is provided and valid; missing or incorrect IDs will cause errors.
  • Authentication errors may occur if the GitLab API credentials are invalid or missing; verify credentials are correctly configured.
  • API request failures can happen if the baseUrl is incorrect or the GitLab instance is unreachable.
  • HTTP method must be set to PUT for this operation; using other methods may result in unexpected behavior or errors.

Links

Discussion