Add MSSQL instance
Select
This operation adds a new MSSQL instance to an existing client
- application/json
Request Body
instanceProperties object
instance object
clientName string requiredName of the client where the SQL instance is present
instanceName string requiredName of the instance to be added
appName string requiredDefault value:
SQL SERVER
planEntity object
planId integer requiredID of the plan to be associated with the instance
mssqlInstance object
useVss booleanDefault value:
false
vDITimeOut integerDefault value:
300
isOnDemand booleanDefault value:
false
MSSQLCredentialinfo object
Pass this object only when "overrideGlobalAuthentication" is set to true and "useLocalSystemAccount" is set to false
credentialId integerID of the credential record. This credential will be used for impersonation for backup/restore operation on this instance.
credentialName stringName of the credential record
recordType integerRecord type of the credential.
overrideHigherLevelSettings object required
useLocalSystemAccount booleanDefault value:
true
Set this to true if you want to use the local system account for SQL backup/restores
overrideGlobalAuthentication booleanDefault value:
false
Set this to true if you want to override the higher level authentication settings
- 200
- 400
- 401
OK
Response Headers
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid.
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
Default value:
Access denied
- errorCode integer
Default value:
5
{
"errorMessage": "Access denied",
"errorCode": 5
}
{
"errorMessage": "Access denied",
"errorCode": 5
}