GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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. Delete a cluster with ID 123 from the GitLab admin clusters.
  2. Automate cluster management by removing clusters that are no longer needed.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
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 DELETE is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the cluster_id to identify which cluster to delete.

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • body - Response body from the GitLab API after attempting to delete the cluster.

Dependencies

  • GitLab API authentication token or credentials

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 token is missing, invalid, or lacks sufficient permissions to delete clusters.
  • Network or baseUrl misconfiguration can lead to connection failures; verify the baseUrl is correct for your GitLab instance.

Links

Discussion