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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function deletes a specified remote MySQL® profile.

Examples 


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


Notes:

  • Unless otherwise noted, 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_deleted": "MyProfile2",
    "profile_details": {
      "mysql_port": "3306",
      "mysql_pass": "luggage1234",
      "setup_via": "Unspecified",
      "active": 0,
      "mysql_user": "username2",
      "mysql_host": "192.168.0.2"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remote_mysql_delete_profile"
  }
}
 Output (XML)
<result>
    <data>
        <profile_deleted>MyProfile2</profile_deleted>
        <profile_details>
            <mysql_port>3306</mysql_port>
            <mysql_pass>luggage1234</mysql_pass>
            <setup_via>Unspecified</setup_via>
            <active>0</active>
            <mysql_user>username2</mysql_user>
            <mysql_host>192.168.0.2</mysql_host>
        </profile_details>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remote_mysql_delete_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_deletedstringThe deleted profile's name.A valid string.MyProfile
profile_detailshashA hash of the deleted 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
  • No labels