Skip to main content

Modify instance

Select

Customer Managed

This operation modifies the instance properties using Instance ID.

Path Parameters
  • instanceId integer required

    Id of the instance

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

    Name of the Instance to be modified

  • applicationId integer

    Default value: 125

  • clientName string

    Name of the cloud account

  • commCellId integer

    Default value: 2

  • planEntity object required
  • planName string

    Name of the plan

  • postGreSQLInstance object required
  • MaintainenceDB string required
  • port string required

    It must be specified in hostname:port format.

  • SAUser object
  • userName string required

    Database

  • password string

    Database password in base 64 encoded format

  • sslOpt object
  • sslEnabled boolean
  • sslCa string

    Path to SSL CA File on AccessNode

  • version string required

    Database instance version

Responses

OK


Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
instanceId — path required
Body

{
"instanceProperties": {
"instance": {
"instanceName": "string",
"applicationId": 125,
"clientName": "string",
"commCellId": 2
},
"planEntity": {
"planName": "string"
},
"postGreSQLInstance": {
"MaintainenceDB": "string",
"port": "string",
"SAUser": {
"userName": "string",
"password": "string"
},
"sslOpt": {
"sslEnabled": true,
"sslCa": "string"
}
},
"version": "string"
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"instanceProperties": {
"instance": {
"instanceName": "string",
"applicationId": 125,
"clientName": "string",
"commCellId": 2
},
"planEntity": {
"planName": "string"
},
"postGreSQLInstance": {
"MaintainenceDB": "string",
"port": "string",
"SAUser": {
"userName": "string",
"password": "string"
},
"sslOpt": {
"sslEnabled": true,
"sslCa": "string"
}
},
"version": "string"
}
}'