Skip to main content

modify Instance using name

This operation modifies properties of an existing instance using instance name.

Path Parameters
  • clientName string required
  • appName string required
  • instanceName string required
Header Parameters
  • Accept string required
Request Body required
  • instanceProperties object required
  • description string required
  • mssqlInstance object required
  • MSSQLStorageDevice object required
  • commandLineStoragePolicy object required
  • storagePolicyName string required
  • logBackupStoragePolicy object required
  • storagePolicyName string required
  • isOnDemand boolean required
  • overrideHigherLevelSettings object required
  • overrideGlobalAuthentication boolean required
  • useLocalSystemAccount boolean required
  • userAccount object required
  • password string required
  • userName string required
  • useVss boolean required
  • vDITimeOut int32 required
  • version string required
Responses

OK


Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • instanceId integer
  • clientId integer
  • instanceName string
  • _type_ integer
POST /instance/byName(clientName=:clientName,appName=:appName),instanceName=:instanceName    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
clientName — path required
appName — path required
instanceName — path required
Accept — header required
Body required

{
"instanceProperties": {
"description": "",
"mssqlInstance": {
"MSSQLStorageDevice": {
"commandLineStoragePolicy": {
"storagePolicyName": "CSSP"
},
"logBackupStoragePolicy": {
"storagePolicyName": "CSSP"
}
},
"isOnDemand": false,
"overrideHigherLevelSettings": {
"overrideGlobalAuthentication": false,
"useLocalSystemAccount": true,
"userAccount": {
"password": "",
"userName": ""
}
},
"useVss": true,
"vDITimeOut": 400
},
"version": ""
}
}
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'