MSSQL Target Connector External API Configuration

This topic describes the required and supported Attributes used when adding or MSSQL target applications using the External API
capam32
This topic describes the required and supported Attributes used when adding or MSSQL target applications using the External API:
2
MSSQL Target Application External API Attributes
To add or update a MSSQL Target appliation using the External API, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
extensionType
Required
Default Value
Valid Values
yes
N/A
mssql
sslEnabled
Required
Default Value
Valid Values
false
true, false
port
The target application port.
Required
Default Value
Valid Values
no
N/A
0-65535. The GUI uses default value 1433
instance
The database instance name.
Required
Default Value
Valid Values
no
N/A. If an instance is not specified, the target connector connects with the default database instance.
String.
MSSQL Target Account External API Attributes
To add or update a MSSQL Target account using the External API, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
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.
MSSQL Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName":"mssqlApp", "applicationType":"mssql", "attributes":{"port":"1433","sslEnabled":"true"} }
MSSQL Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"mssqlAct", "attributes":{ "useOtherAccountToChangePassword":"false", "descriptor1":"sample descriptor1" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }