Bulk Delete Sub Domain on cPanel

delete_subdomains.sh

#!/bin/bash

# Define the cPanel username
cpanel_user="your_cpanel_username"

# Define the file containing the list of subdomains
file="domains.txt"

# Define the log file
log_file="deletion_log.txt"

# Maximum number of retries for a failed command
max_retries=3

# Function to delete a subdomain and its document root
delete_subdomain() {
  local domain=$1
  local attempt=1
  local success=0

  while [ $attempt -le $max_retries ]; do
    # Get the current timestamp
    timestamp=$(date +"%Y-%m-%d %H:%M:%S")

    # Fetch document root before deleting the subdomain
    docroot=$(uapi --output=jsonpretty --user="$cpanel_user" DomainInfo domains_data | jq -r ".result.data.sub_domains[] | select(.domain==\"$domain\") | .documentroot")

    if [ -z "$docroot" ]; then
      echo "[$timestamp] ERROR: Could not retrieve document root for $domain" | tee -a "$log_file"
      return
    fi

    # Run the cpapi2 command and capture output and status
    output=$(/usr/local/cpanel/bin/cpapi2 --user="$cpanel_user" SubDomain delsubdomain domain="$domain" 2>&1)
    status=$?

    if [ $status -eq 0 ]; then
      echo "[$timestamp] SUCCESS: Deleted subdomain $domain" | tee -a "$log_file"
      success=1
      break
    else
      echo "[$timestamp] ERROR: Attempt $attempt failed for subdomain $domain" | tee -a "$log_file"
      echo "[$timestamp] Output: $output" | tee -a "$log_file"
      if echo "$output" | grep -q "signal 14 (ALRM)"; then
        echo "[$timestamp] Retrying due to signal 14 (ALRM) error..." | tee -a "$log_file"
      fi
    fi
    attempt=$((attempt + 1))
    sleep 2
  done

  if [ $success -eq 1 ]; then
    # Delete the document root if the subdomain was successfully removed
    if [ -d "$docroot" ]; then
      rm -rf "$docroot"
      echo "[$timestamp] SUCCESS: Deleted document root $docroot" | tee -a "$log_file"
    else
      echo "[$timestamp] WARNING: Document root $docroot does not exist" | tee -a "$log_file"
    fi
  else
    echo "[$timestamp] ERROR: All attempts failed for subdomain $domain" | tee -a "$log_file"
  fi
}

# Loop through each line in the file
while IFS= read -r domain; do
  delete_subdomain "$domain"
done < "$file"

domains.txt

sub1.example.com
sub2.example.com
sub3.example.com

Subdomain Deletion Script with Error Handling and Logging

This Bash script automates the process of deleting subdomains using the cPanel API (cpapi2). It reads subdomains from a text file and executes the deletion command for each entry.

How to Use

1. Download the Script:
   Save the script as delete_subdomains.sh.

2. Adjust File:
   Modify file delete_subdomains.sh line 4 on your_cpanel_username with your actual cPanel Username

3. Make It Executable:
   Run the following command to grant execute permissions:

chmod +x delete_subdomains.sh

4. Prepare the Subdomains List:
   Create or update the domains.txt file in the same directory as the script.

5. Run the Script:
   Execute the script with:

./delete_subdomains.sh

6. Check the Logs:
   The script logs all activities in deletion_log.txt. This includes timestamps, success messages, error messages, and debug output for failed attempts.