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

 

Description

This function validates a specified remote MySQL® profile's connection details.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_validate_profile?api.version=1&name=MyProfile
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remote_mysql_validate_profile?api.version=1&name=MyProfile


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

 Command Line
whmapi1 remote_mysql_validate_profile name=MyProfile


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_validated": "MyProfile"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remote_mysql_validate_profile"
  }
}
 Output (XML)
<result>
    <data>
        <profile_validated>MyProfile</profile_validated>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remote_mysql_validate_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 profile's name.

A valid string.MyProfile

Returns

Return

TypeDescriptionPossible valuesExample
profile_validatedstringThe validated profile's name.A valid string.MyProfile