cPanel WHM icon

cPanel WHM

Full cPanel WHM API — all 622 operations across Accounts, DNS, Mail, SSL, Backups, Databases and more

Actions262

Database → Create remote MySQL profile via SSH

AI-generated

Summary

Create a remote MySQL database connection profile via SSH on the cPanel WHM server.

Inputs

  • Host (required) — The IP address or hostname of the MySQL server to connect to remotely.
  • Name (required) — The name to assign to the new remote MySQL profile.
  • Port (required) — The SSH port number on the remote server (1-65535).
  • User (required) — The SSH username for authenticating the connection.
  • Password — The SSH password for the SSH user (required if SSH key is not used).
  • Sshkey Name — The name of the SSH key to authenticate with (required if password is not provided).
  • Sshkey Passphrase — The passphrase for the SSH key if it is password-protected.
  • Root Escalation Method — The method used to escalate permissions if the SSH user is not root; either 'sudo' or 'su' (required if user is not 'root').
  • Root Password — The root user's password on the MySQL server, required if escalation method is 'su'.
  • Cpcloud — Indicates if the remote database profile is a cPanel Cloud deployment (1 for yes, 0 for no).

Output shape

a single record containing the result of the profile creation operation

Requires specifying either the SSH password or SSH key name. If the SSH user is not 'root', the root escalation method must be provided. The operation returns the WHM API response indicating success or failure of the profile creation.

Links

Discussion