MySQL Target Connector External API Configuration
capam32
This topic describes the required and supported Attributes used when adding or updating a MSSQL Target Application using the External API:
2
MySQL Target Application External API Attributes
To add or update a MySQL application using the External API, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
port
The target application port.
Required | Default Value | Valid Values |
|---|---|---|
yes | 3306 | 0-65535 |
MySQL Target Account External API Attributes
To add a MySQL target account that uses the target connector, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
schema
The name of the database schema to which the account belongs.
Required | Default Value | Valid Values |
|---|---|---|
yes | N/A | String |
useOtherAccountToChangePassword
Specifies whether to use the target account or a different account to perform password change requests.
Required | Default Value | Valid Values |
|---|---|---|
yes | N/A | true, false |
otherAccount
Specifies which other account to use to perform password change requests.
Required | Default Value | Valid Values |
|---|---|---|
yes if useOtherAccountToChangePassword is true. | N/A | A valid target account ID. |
hostNameQualifier
Specifies which other account to use to perform password change requests.
Required | Default Value | Valid Values |
|---|---|---|
yes if useOtherAccountToChangePassword is true. | MySQL wildcard (%) | A valid target account ID. |
MySQL Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName":"mysqlApp", "applicationType":"mysql", "attributes":{"port":"3306"} }
MySQL Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"mysqlAct", "attributes":{ "useOtherAccountToChangePassword":"false", "schema":"master" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }