GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a specific cluster in the GitLab Admin Clusters resource 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 their cluster IDs.

Use Case Examples

  1. Deleting a cluster with cluster ID 12345 to remove it from the GitLab admin clusters list.
  2. Automating cluster management by deleting clusters that are no longer needed.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET but here it is DELETE for this operation.
Path Parameters The path parameters for the request, specifically the cluster_id which identifies the cluster to delete.

Output

JSON

  • statusCode - The HTTP status code returned by the API after attempting to delete the cluster.
  • responseBody - The JSON response body from the API, typically empty or containing confirmation of deletion.

Dependencies

  • GitLab API key credential for authentication

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 GitLab API key credential is missing or invalid; verify credentials are correctly configured.
  • Network or baseUrl misconfiguration can cause connection failures; confirm the baseUrl is correct and accessible.

Links

Discussion