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

  clientName string

  Name of the cloud account

  planEntity object required

  planName string

  Name of the plan

  mySqlInstance object required

  SAUser object

  userName string required

  Database username

  password string

  Database password in base 64 encoded format

  confirmPassword string

  Database password in base 64 encoded format

  port string required

  It must be specified in hostname:port format

  sslEnabled boolean

  sslCa string

  Path to SSL CA File on Access Node

  EnableAutoDiscovery boolean

  Default value: true

Responses

• 200
• 404

---

OK

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

tokenbearerToken

token

instanceId — path required

Body

• Default
• Enable SSL
• Disable SSL
• Update password

---

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'

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": 104,
      "clientName": "string"
    },
    "planEntity": {
      "planName": "string"
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "port": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "EnableAutoDiscovery": true
    }
  }
}'