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
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

application/json

Schema
Example (from schema)
Example 1

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

{
  "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

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

instanceId — path required

Body

Default
Example 1

{
  "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"
  }
}'

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"
  }
}'

Modify instance​

Authorization

Request

Modify instance