Child pages
  • WHM API 1 Functions - remote_mysql_create_profile_via_ssh
Skip to end of metadata
Go to start of metadata

 

Description

This function uses SSH to create a profile to access a remote MySQL® server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_create_profile_via_ssh?api.version=1&name=created_via_ssh&host=192.168.0.1&user=root&password=12345luggage&port=22
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remote_mysql_create_profile_via_ssh?api.version=1&name=created_via_ssh&host=192.168.0.1&user=root&password=12345luggage&port=22
 Command Line
whmapi1 remote_mysql_create_profile_via_ssh name=created_via_ssh host=192.168.0.1 user=root password=12345luggage port=22


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "profile_details": {
      "mysql_port": "22",
      "setup_via": "Created via SSH",
      "mysql_pass": "12345luggage",
      "active": 0,
      "mysql_user": "root",
      "mysql_host": "192.168.0.1"
    },
    "profile_saved": "MyProfileSSH"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remote_mysql_create_profile_via_ssh"
  }
}
 Output (XML)
<result>
    <data>
        <profile_details>
            <mysql_port>22</mysql_port>
            <setup_via>Created via SSH</setup_via>
            <mysql_pass>12345luggage</mysql_pass>
            <active>0</active>
            <mysql_user>username</mysql_user>
            <mysql_host>192.168.0.1</mysql_host>
        </profile_details>
        <profile_saved>MyProfileSSH</profile_saved>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remote_mysql_create_profile</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The new profile's name.

A valid string.MyProfileSSH
userstring

Required

The SSH username.

A valid username.SSHuser
passwordstring

The SSH username's password.

Warning:

You must specify either the password or the sshkey_name parameter.


A valid string.12345luggage
sshkey_namestring

The name of the SSH key.

Warning:

You must specify either the password or the sshkey_name parameter.

A valid string.VinzClortho
sshkey_passphrasestring

The SSH key's passphrase.

Warning:

This parameter is required if the sshkey_name value is password-protected.

A valid string.Gozer
hoststring

Required

The MySQL server's IP address or hostname.

A valid IP address or hostname.192.168.0.1
portinteger

Required

The SSH server's port.

A valid positive integer.22
root_escalation_methodstring

The escalation method to use to authenticate the account.

Warning:

This parameter is required if the user parameter's value is not root.

  • sudo
  • su
su
root_passwordstring

The MySQL server's root user's password.

Warning:

This parameter is required if the root_escalation_method parameter's value is su.

A valid string.username

Returns

Return

TypeDescriptionPossible valuesExample
profile_detailshashA hash of the new profile's data.This hash includes the mysql_host, mysql_user, mysql_pass, mysql_port, setup_via, and active returns. 

mysql_host

string

The MySQL server's IP address or hostname.

The function returns this value in the profile_details hash.

A valid IP address or hostname.192.168.0.1

mysql_user

string

The MySQL server's username.

The function returns this value in the profile_details hash.

A valid string.username

mysql_pass

string

The MySQL server's password.

The function returns this value in the profile_details hash.

A valid string.12345luggage

mysql_port

integer

The MySQL server's port.

The function returns this value in the profile_details hash.

A valid positive integer.3306

setup_via

string

A description of the profile data.

The function returns this value in the profile_details hash.

A valid string with a maximum length of 255 characters.Created via SSH

active

Boolean

Whether the system uses this profile to access the MySQL server.

The function returns this value in the profile_details hash.

  • 1 — Active.
  • 0 — Not active.
0
profile_savedstringThe new profile's name.A valid string.MyProfileSSH