Skip to main content

Add MSSQL instance

Select

SaaS
Customer Managed

This operation adds a new MSSQL instance to an existing client

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

    Name of the client where the SQL instance is present

  • instanceName string required

    Name of the instance to be added

  • appName string required

    Default value: SQL SERVER

  • planEntity object
  • planId integer required

    ID of the plan to be associated with the instance

  • mssqlInstance object
  • useVss boolean

    Default value: false

  • vDITimeOut integer

    Default value: 300

  • isOnDemand boolean

    Default value: false

  • MSSQLCredentialinfo object

    Pass this object only when "overrideGlobalAuthentication" is set to true and "useLocalSystemAccount" is set to false

  • credentialId integer

    ID of the credential record. This credential will be used for impersonation for backup/restore operation on this instance.

  • credentialName string

    Name of the credential record

  • recordType integer

    Record type of the credential.

  • overrideHigherLevelSettings object required
  • useLocalSystemAccount boolean

    Default value: true

    Set this to true if you want to use the local system account for SQL backup/restores

  • overrideGlobalAuthentication boolean

    Default value: false

    Set this to true if you want to override the higher level authentication settings

Responses

OK

Response Headers
    Loading...