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

 

Description

This function creates a profile to access a remote MySQL® server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_create_profile?api.version=1&name=MyProfile&mysql_host=192.168.0.1&mysql_user=username&mysql_pass=1234luggage&mysql_port=3306&setup_via=Main %20terminal
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remote_mysql_create_profile?api.version=1&name=MyProfile&mysql_host=192.168.0.1&mysql_user=username&mysql_pass=1234luggage&mysql_port=3306&setup_via=Main%20terminal
 Command Line
whmapi1 remote_mysql_create_profile name=MyProfile mysql_host=192.168.0.1 mysql_user=username mysql_pass=12345luggage mysql_port=3306 setup_via="Main terminal"


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": "3306",
      "setup_via": "Main terminal",
      "mysql_pass": "1234luggage",
      "active": 0,
      "mysql_user": "username",
      "mysql_host": "192.168.0.1"
    },
    "profile_saved": "MyProfile"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remote_mysql_create_profile"
  }
}
 Output (XML)
<result>
    <data>
        <profile_details>
            <mysql_port>3306</mysql_port>
            <setup_via>Main terminal</setup_via>
            <mysql_pass>1234luggage</mysql_pass>
            <active>0</active>
            <mysql_user>username</mysql_user>
            <mysql_host>192.168.0.1</mysql_host>
        </profile_details>
        <profile_saved>MyProfile</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.MyProfile
mysql_hoststring

Required

The MySQL server's IP address or hostname.

A valid IP address or hostname.192.168.0.1
mysql_userstring

Required

The MySQL server's username.

A valid string.username
mysql_passstring

Required

The MySQL server's password.

A valid string.12345luggage
mysql_portinteger

Required

The MySQL server's port.

A valid positive integer.3306
setup_viastring

A description of the profile data.

The default value is User provided MySQL credentials.

A valid string with a maximum length of 255 characters.Main terminal

Returns

Return

TypeDescriptionPossible valuesExample
profile_detailshashA hash of the new profile's data.This hash includes the name, 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.Main terminal

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.
  • 0Not active.
0
profile_savedstringThe new profile's name.A valid string.MyProfile