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

Description


This function displays the details of all remote MySQL® profiles available in WHM.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_read_profiles?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remote_mysql_read_profiles?api.version=1
 Command Line
whmapi1 remote_mysql_read_profiles


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": {
    "MyProfile2": {
      "mysql_port": "3306",
      "setup_via": "Main terminal",
      "mysql_pass": "1234luggage",
      "active": 0,
      "mysql_user": "username",
      "mysql_host": "192.168.0.2"
	  "is_localhost_profile": "1"
	  "mysql_version_is_supported": "0"
 
    },
    "MyProfile": {
      "mysql_port": "3306",
      "mysql_pass": "1234luggage",
      "setup_via": "Main terminal",
      "active": 0,
      "mysql_user": "username",
      "mysql_host": "192.168.0.1"
	  "is_localhost_profile": "1"
	  "mysql_version_is_supported": "0"
    },
    "localhost": {
      "mysql_port": "3306",
      "mysql_pass": "#1mpll-C",
      "setup_via": "Auto-Migrated active profile",
      "active": "1",
      "mysql_user": "root",
      "mysql_host": "localhost"
	  "is_localhost_profile": "1"
	  "mysql_version_is_supported": "0"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remote_mysql_read_profiles"
  }
}
 Output (XML)
<result>
    <data>
        <MyProfile2>
            <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.2</mysql_host>
			<is_localhost_profile>1</is_localhost_profile>
			<mysql_version_is_supported>0</mysql_version_is_supported>
        </MyProfile2>
        <MyProfile>
            <mysql_port>3306</mysql_port>
            <mysql_pass>1234luggage</mysql_pass>
            <setup_via>Main terminal</setup_via>
            <active>0</active>
            <mysql_user>username</mysql_user>
            <mysql_host>192.168.0.1</mysql_host>
			<is_localhost_profile>1</is_localhost_profile>
			<mysql_version_is_supported>0</mysql_version_is_supported>
        </MyProfile>
        <localhost>
            <mysql_port>3306</mysql_port>
            <mysql_pass>#1mpll-C</mysql_pass>
            <setup_via>Auto-Migrated active profile</setup_via>
            <active>1</active>
            <mysql_user>root</mysql_user>
            <mysql_host>localhost</mysql_host>
			<is_localhost_profile>1</is_localhost_profile>
			<mysql_version_is_supported>0</mysql_version_is_supported>
        </localhost>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remote_mysql_read_profiles</command>
    </metadata>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample
profile_namehash

A hash of the profile's data.

Note:

The profile's name is the return's name.

This hash includes the name, mysql_host, mysql_user, mysql_pass, mysql_port, setup_via, is_localhost_profile, mysql_version_is_supported, and active returns. 

mysql_host

string

The MySQL server's IP address or hostname.

The function returns this value in the profile_name 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_name   hash.

A valid string.username

mysql_pass

string

The MySQL server's password.

The function returns this value in the profile_name hash.

A valid string.12345luggage

mysql_port

integer

The MySQL server's port.

The function returns this value in the profile_name   hash.

A valid positive integer.3306

mysql_version_is_supported

 

Boolean

Whether the system supports the server's MySQL version.

Note:

We introduced this return in cPanel & WHM version 64.

The function returns this value in the profile_name hash.


  • 1 — Supported.
  • 0Not supported.
0

is_localhost_profile

Boolean

Whether the system's MySQL profile functions with the server's local MySQL instance.

Note:

We introduced this return in cPanel & WHM version 64.


The function returns this value in the profile_name hash.
  • 1 — Functions.
  • 0 — Does not function.
1

setup_via

string

A description of the profile data.

The function returns this value in the profile_name   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_name   hash.

  • 1 — Active.
  • 0Not active.
0