Actions262
- Account Actions
- Return cPanel account summary
- Assign Account Enhancement
- Create Account Enhancement
- Create cPanel account
- Remove an Account Enhancement
- Enable forced password update
- Return cPanel accounts total number
- Return home directories list
- Return maximum accounts for license
- Return password strength
- Get scoped userdata
- Get upgrade opportunities
- Validate cPanel account Digest Authentication
- Validate MySQL Configuration file
- Return Account Enhancements
- Return root and cPanel accounts
- Return cPanel accounts
- Return suspended cPanel accounts
- Return suspended cPanel accounts and information
- Update multiple cPanel accounts
- Update Account Enhancement
- Update cPanel account
- Return cPanel account system privileges
- Update cPanel account password
- Delete cPanel account
- Enable or disable Digest Authentication
- Set scoped userdata
- Suspend cPanel account
- Unassign Account Enhancement
- Unsuspend cPanel account
- Remove UID or GID from tracked list
- Validate new cPanel account username
- Backup Actions
- Return backup configuration file data
- Update the system's backup configuration
- Return dates where backup files exist
- Add a backup destination
- Delete a backup destination
- Return a backup destination's settings
- Return a list of backup destinations
- Update backup destination settings
- Validate a backup destination
- Return Google Drive™ client ID credentials
- Create Google Drive™ OAuth redirect URI
- Return backup transport events' status
- Return backup files sent through transport
- Return backup files in the local disk
- Return backup files for the server's accounts
- Enable or disable backups
- Return backup configuration status
- Return users with a backup file
- Migrate server to new backup system
- Return start_background_pkgacct session log file
- Return start_background_pkgacct session state
- Return users and domains with backup metadata
- Return users with backup metadata
- Return cparchive files list
- Return backup modules list
- Start restoration
- Restore user account from backup
- Remove all completed restoration tasks
- Remove all failed restoration tasks
- Remove all pending restoration tasks
- Remove all restoration tasks
- Remove completed restoration task
- Remove pending restoration task
- Validate restoration queue is active
- Return active restoration tasks list
- Return completed restoration tasks list
- Return pending restoration tasks list
- Return restoration tasks list
- Restore account backup
- Back up an account using the pkgacct script
- Restore one cPanel account from a backup
- Enable or disable legacy backups
- Validate username during restoration
- Database Actions
- Validate MySQL status before upgrade
- Return MySQL or MariaDB upgrade status
- Return MySQL version
- Return MySQL database optimizations
- Return available MySQL versions
- Return latest MySQL version
- Return MySQL users
- Return MySQL databases
- Return MySQL databases and users for account
- Create remote MySQL profile
- Create remote MySQL profile via SSH
- Delete remote MySQL profile
- Start remote MySQL profile activation
- Return remote MySQL profile activation
- Return remote MySQL profile
- Return remote MySQL profiles
- Update remote MySQL profile
- Validate remote MySQL profile connection
- Update MySQL database name
- Update MySQL username
- Update PostgreSQL database name
- Update PostgreSQL username
- Update MySQL root password
- Update MySQL user password
- Update PostgreSQL user password
- Start background MySQL upgrade
- Update the servers SQL configuration.
- DNS Actions
- Enable domain's DNSSEC key
- Create domain's DNSSEC zone key
- Create DNS zone
- Create DNS zone record
- Return whether DNS cluster server can share records
- Create domain alias
- Create subdomain
- Disable domain's DNSSEC key
- Delete domain
- Disable DNSSEC on domain
- Return domain's DNS zone configuration
- Update DNS zone record
- Enable DNSSEC on domain
- Export domain's DNSKEY record value
- Export DNS zones in zone file format
- Export domain's DNSSEC key
- Return domain's DS record
- Return current user's nameservers
- Return specific line from domain's DNS configuration
- Validate local server is authoritative
- Import DNSSEC key
- Return `ALIAS` DNS record availability & resolver
- Return HTTPS DNS record support information
- Return SVCB DNS record support information
- Delete DNS zone
- Return domain's mail exchanger records
- Return server's DNS zones
- Return nameserver's IP address
- Return nameserver's IPv4 and IPv6 addresses
- Update a DNS zone
- Return a parsed DNS zone
- Remove DNSSEC key
- Delete DNS zone record
- Restore DNS zone to default values
- Return domain's IP address
- Create mail exchanger record
- Update remote DNS server's nameserver software
- Enable NSEC3 semantics for domain
- Create unbound DNS resolver
- Update server's resolver nameservers
- Enable NSEC semantics for domain
- Update default nameservers
- Update reverse DNS cache
- Update /etc/userdomains file
- Domain Actions
- Return additional domain conversion details
- Return additional domain data
- Return conversion status for additional domain
- Start additional domain conversion
- Return current user's additional domains
- Return additional domains conversion queue
- Return domain user information
- Return all domains information
- Return domain owner
- IP & Network Actions
- Add IP addresses
- Remove IP address
- Update cPanel account disk quota
- Return all cPanel accounts disk usage
- Return public IP address of private IP address
- Return shared IP address
- Remove IPv6 address range from account
- Add IPv6 address range to accounts
- Add IPv6 address range
- Update IPv6 address range name or note
- Return available IPv6 address ranges
- Remove IPv6 address range
- Return IPv6 address usage
- Update cPanel account bandwidth quota
- Return server's IP addresses
- Return server's IPv6 addresses
- Validate public IP address for NAT
- Register NAT IP address to public IP address
- Validate cPanel account quotas
- Update domain or cPanel account IP address
- Return cPanel account bandwidth information
- Mail Actions
- Apply a DMARC record to a domain
- Add block on emails from specific countries
- Add block on emails from specific domains
- Return Greylisting trust status of server netblock
- Return Greylisting IP addresses of mail providers
- Return Greylisting mail providers
- Update Greylisting new mail provider handling
- Return Greylisting status
- Add mail provider to Greylisting trusted hosts
- Add mail provider to Greylisting non-trusted hosts
- Add IP address to Greylisting trusted hosts
- Remove IP address from Greylisting trusted hosts
- Disable Greylisting
- Disable domain's DKIM records
- (Deprecated) Disable SNI mail services for domains
- Return email delivery records by search criteria
- Return cPanel account email tracking statistics
- Return all cPanel accounts email tracking statistics
- Enable Greylisting
- Enable domain's DKIM records
- Enable SNI mail services for domains
- Validate domain's DKIM keys
- Repair Exim configuration file
- Remove email account messages by Dovecot query
- Remove email account messages by mailbox GUID
- Return domain's DKIM private key
- Return server mail queue contents
- Create email account mobile profile configuration
- Get the server's default DMARC record
- Return cPanel account mailboxes status by name
- Return cPanel account mailboxes status list
- Return cPanel account unique email recipients
- Return all cPanel account unique email recipients
- Return cPanel account forward destination
- Add cPanel account to outbound email hold queue
- Install existing private key to DKIM record
- Install domain SPF record
- Return server SNI support status
- Return blocked email countries list
- Return blocked email domains list
- Return cPanel account's email accounts
- Return Greylisting settings
- Return domain's SNI mail services status
- Repair misconfigured email settings
- Return Greylisting deferred incoming email triplets
- Return Greylisting trusted hosts
- Rebuild mail SNI configuration files
- Release cPanel account queued outgoing emails
- Remove domains' DMARC records.
- Update Greylisting settings
- Update Apache SpamAssassin™ configuration
- Set the server's default DMARC record
- Add manual mail exchanger redirect record
- Update cPanel account email forward destination
- Suspend cPanel account outgoing email
- Stop cPanel account IMAP and POP3 connections
- Remove block on emails from specific countries
- Remove block on emails from specific domains
- Remove manual mail exchanger redirect record
- Unsuspend account outgoing email
- Validate DKIM records
- Validate DMARC records
- Validate Exim configuration
- Validate domain PTR records
- Validate domain SPF records
- Validate Exim configure file syntax
- Package Actions
- Check if a plugin feature is ready for use
- Disable feature locally
- Enable feature locally
- Return hosting plan extension templates
- Add cPanel account feature list overrides
- Create hosting plan
- Add hosting plan extension
- Update user hosting plan
- Create feature list
- Delete feature list
- Remove hosting plan extension
- Update hosting plan
- Return dynamicui file
- (Deprecated) Get available feature lists
- Return current user's available feature lists info
- Return all features
- Return feature list configuration
- Return current user's available feature lists
- Return feature lists by package type
- Return cPanel accounts' feature settings
Account → Get upgrade opportunities
AI-generatedSummary
Retrieve a list of cPanel accounts that are eligible for upgrades based on their disk usage thresholds and usage nearness criteria.
Inputs
- Disk Threshold Blocks — Specify a fixed number of disk blocks to use as an alternative threshold for disk usage to trigger upgrade opportunities. Defaults to 2097152 blocks if not provided.
- Nearness Fraction — Set the fraction (between 0 and 1) representing how close an account's usage must be to the threshold to consider it "near" and thus eligible for upgrade opportunities. Defaults to 0.8.
Output shape
a single JSON object containing the list of accounts that meet the upgrade criteria based on disk usage thresholds and nearness fraction parameters.
The output includes all accounts whose disk usage meets or exceeds the specified threshold or nearness fraction criteria. If no parameters are specified, default values are applied. The response strictly represents upgrade candidates without pagination.