Skip to main content

Update the YugabyteDB instance properties​

Select

SaaS
Customer Managed

This operation is used to update the YugabyteDB Instance properties

Path Parameters
  • instanceId integer required

    Id of the YugabyteDB instance to be updates

Request Body required

Request Body

  • instanceProperties object
  • excludeFromSLA boolean
  • instance object
  • instanceId integer required

    YugabyteDB instance id

  • clientId integer required

    YugabyteDB instance client id

  • applicationId integer required

    Default value: 64

  • distributedClusterInstance object
  • clusterType integer
  • opType integer
  • instance object
  • instanceName string

    YugabyteDB instance name

  • instanceId integer
  • clusterConfig object
  • yugabytedbConfig object
  • dbHost string

    IP or hostname of yugabytedb anywhere host

  • customerConfig object
  • name string

    Yugabytedb customer config name

  • uuid string

    Yugabytedb customer config uuid

  • universe object
  • name string

    Yugabytedb universe name

  • uuid string

    Yugabytedb universe uuid

  • customer object
  • name string

    Yugabytedb customer name

  • uuid string

    Yugabytedb customer uuid

  • config object
  • staging object
  • stagingType integer
  • serviceHost string
  • cloudURL string
  • recordType integer
  • instanceType integer
  • stagingPath string
  • stagingCredentials object
  • credentialId integer
  • credentialName string
  • recordType integer
  • description string
  • selected boolean
  • dataAccessNodes object
  • dataAccessNodes object[]
  • hostName string
  • clientId integer
  • clientName string
  • displayName string
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://localhost/webconsole/api
token
instanceId — path required
Body required
{

  "instanceProperties": {

    "excludeFromSLA": true,

    "instance": {

      "instanceId": 0,

      "clientId": 0,

      "applicationId": 64

    },

    "distributedClusterInstance": {

      "clusterType": 0,

      "opType": 0,

      "instance": {

        "instanceName": "string",

        "instanceId": 0

      },

      "clusterConfig": {

        "yugabytedbConfig": {

          "dbHost": "string",

          "customerConfig": {

            "name": "string",

            "uuid": "string"

          },

          "universe": {

            "name": "string",

            "uuid": "string"

          },

          "customer": {

            "name": "string",

            "uuid": "string"

          }

        },

        "config": {

          "staging": {

            "stagingType": 0,

            "serviceHost": "string",

            "cloudURL": "string",

            "recordType": 0,

            "instanceType": 0,

            "stagingPath": "string",

            "stagingCredentials": {

              "credentialId": 0,

              "credentialName": "string",

              "recordType": 0,

              "description": "string",

              "selected": true

            }

          }

        }

      },

      "dataAccessNodes": {

        "dataAccessNodes": [

          {

            "hostName": "string",

            "clientId": 0,

            "clientName": "string",

            "displayName": "string"

          }

        ]

      }

    }

  }

}

curl -L -X POST 'https://localhost/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "excludeFromSLA": true,
    "instance": {
      "instanceId": 0,
      "clientId": 0,
      "applicationId": 64
    },
    "distributedClusterInstance": {
      "clusterType": 0,
      "opType": 0,
      "instance": {
        "instanceName": "string",
        "instanceId": 0
      },
      "clusterConfig": {
        "yugabytedbConfig": {
          "dbHost": "string",
          "customerConfig": {
            "name": "string",
            "uuid": "string"
          },
          "universe": {
            "name": "string",
            "uuid": "string"
          },
          "customer": {
            "name": "string",
            "uuid": "string"
          }
        },
        "config": {
          "staging": {
            "stagingType": 0,
            "serviceHost": "string",
            "cloudURL": "string",
            "recordType": 0,
            "instanceType": 0,
            "stagingPath": "string",
            "stagingCredentials": {
              "credentialId": 0,
              "credentialName": "string",
              "recordType": 0,
              "description": "string",
              "selected": true
            }
          }
        }
      },
      "dataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'