GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 by specifying the cluster ID and providing the updated data in the request body. For example, an admin can update cluster configurations or metadata by sending a PUT request to the GitLab API endpoint for clusters.

Use Case Examples

  1. Updating cluster details by providing the cluster ID and new configuration data in the request body.
  2. Automating cluster management tasks in GitLab through API calls.

Properties

Name Meaning
Skip Authentication Option to skip API authentication, useful for testing or public endpoints.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but PUT is used for this operation.
Path Parameters Parameters to be included in the 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, containing updated cluster details or status.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the cluster_id path parameter is correctly provided and is a valid integer, as it is required for the API call.
  • Verify that the authentication credentials for GitLab API are correctly set unless Skip Authentication is enabled.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Common errors include 401 Unauthorized if authentication fails, 404 Not Found if the cluster ID does not exist, and 400 Bad Request if the request body schema is invalid.

Links

Discussion