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

Description

This function checks whether a cPanel user's home directory contains a valid .my.cnf file.

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


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":
    {
       "has_mycnf_for_cpuser":1,
    },
       "metadata":
   {
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"has_mycnf_for_cpuser"
    }
}
 Output (XML)
<result>
    <data>
      <has_mycnf_for_cpuser>1</has_mycnf_for_cpuser>
    </data>
    <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>has_mycnf_for_cpuser</command>
    </metadata>
  </result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account username.

A valid cPanel username on the server.

user

Returns

ReturnTypeDescriptionPossible valuesExample
has_mycnf_for_cpuserBooleanWhether a valid .my.cnf file exists in the account's home directory.
  • 1 — Exists.
  • 0 — Does not exist.
1