Modify instance
Select
Customer Managed
This operation modifies the instance properties using Instance ID.
Path Parameters
- instanceId integer required
Id of the instance
- application/json
Request Body
instanceProperties object
Responses
- 200
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
response object[]
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "",
"instanceId": 0,
"_type_": 0
}
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Unknown Instance information. Please provide valid instance id to complete the operation.",
"errorCode": 587206385
}
POST /instance/:instanceid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
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"
}
}'
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"
}
}'
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"
}
}'
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"
}
}'
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"
}
}'
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"
}
}'
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"
}
}'