Skip to main content

Add MySQL Instance​

This operation adds a MySQL Instance in Client

Request Body
  • instanceProperties object required
  • instance object
  • instanceName string required

    Name of the MySQL Instance

  • applicationId integer required

    Default value: 104

    104 for MySQL

  • clientId integer required

    ClinetID in which MySQL Instance is to be added

  • clientName string
  • mySqlInstance object required
  • BinaryDirectory string required

    Binary directory of MySQL Server

  • LogDataDirectory string required

    Log Directory Of MySQL Server

  • ConfigFile string required

    Configuration file of MySQL Server

  • port string required

    Port number for Windows, Socket File/ Endpoint for

  • EnableAutoDiscovery boolean
  • SAUser object
  • userName string required

    MySQL database username

  • password string

    Base64 encrypted database user password

  • NTUser object
  • userName string

    Windows NT username

  • password string

    Base64 encode Windows NT user password

  • proxySettings object
  • isProxyEnabled boolean
  • proxyInstance object

    Proxy Instance name

  • instanceId integer
  • isUseSSL boolean
  • runBackupOnProxy boolean
  • xtraBackupSettings object

    Percona Xtrabackup setting

  • enableXtraBackup boolean
  • mebSettings object

    MySQL Enterprise Backup setting

  • enableMEB boolean
  • sslEnabled boolean
  • planEntity object required
  • planId integer
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Content-Type
Body
{

  "instanceProperties": {

    "instance": {

      "instanceName": "string",

      "applicationId": 104,

      "clientId": 0,

      "clientName": "string"

    },

    "mySqlInstance": {

      "BinaryDirectory": "string",

      "LogDataDirectory": "string",

      "ConfigFile": "string",

      "port": "string",

      "EnableAutoDiscovery": true,

      "SAUser": {

        "userName": "string",

        "password": "string"

      },

      "NTUser": {

        "userName": "string",

        "password": "string"

      },

      "proxySettings": {

        "isProxyEnabled": true,

        "proxyInstance": {

          "instanceId": 0

        },

        "isUseSSL": true,

        "runBackupOnProxy": true

      },

      "xtraBackupSettings": {

        "enableXtraBackup": true

      },

      "mebSettings": {

        "enableMEB": true

      },

      "sslEnabled": true

    },

    "planEntity": {

      "planId": 0

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 104,
      "clientId": 0,
      "clientName": "string"
    },
    "mySqlInstance": {
      "BinaryDirectory": "string",
      "LogDataDirectory": "string",
      "ConfigFile": "string",
      "port": "string",
      "EnableAutoDiscovery": true,
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "NTUser": {
        "userName": "string",
        "password": "string"
      },
      "proxySettings": {
        "isProxyEnabled": true,
        "proxyInstance": {
          "instanceId": 0
        },
        "isUseSSL": true,
        "runBackupOnProxy": true
      },
      "xtraBackupSettings": {
        "enableXtraBackup": true
      },
      "mebSettings": {
        "enableMEB": true
      },
      "sslEnabled": true
    },
    "planEntity": {
      "planId": 0
    }
  }
}'