GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a specific cluster in GitLab by its cluster ID. It is useful for administrators who need to manage and remove clusters from their GitLab instance programmatically. For example, an admin can automate the cleanup of unused or deprecated clusters by specifying the cluster ID to delete.

Use Case Examples

  1. Deleting a cluster with ID 123 from the GitLab admin clusters.
  2. Automating cluster management by removing clusters that are no longer needed.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, default is GET but can be set to DELETE for this operation.
Path Parameters The path parameters required for the request, specifically the cluster_id to identify which cluster to delete.

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • responseBody - The body of the response returned after attempting to delete the cluster.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the cluster_id path parameter is provided and valid; missing or incorrect cluster_id will cause the request to fail.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials are correctly configured.
  • HTTP method must be set to DELETE for this operation; using other methods may result in errors.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion