Skip to main content

Create Instance

This API creates GCP PaaS Database Instance for PostgreSQL. All the databases in the PostgreSQL instance will be backed up after creation.

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

    Name of the Instance

  • applicationId integer

    Default value: 125

  • clientName string

    Name of the cloud account

  • version string required

    Database instance version

  • postGreSQLInstance object required
  • MaintainenceDB string
  • port string

    It must be specified in hostname:port format.

  • SAUser object
  • userName string

    Database username

  • password string

    Database password in base 64 encoded format

  • cloudDBEngineType string required

    Possible values: [POSTGRESQL]

  • sslOpt object
  • sslEnabled boolean

    Default is false

  • sslCa string

    Path to SSL CA file on the Access Node

  • sslKey string

    Path to Client Key file on the Access Node

  • sslCert string

    Path to SSL Client Cert file on the Access Node

  • planEntity object required
  • planName string

    Name of the Plan

  • dbEngine string required

    Possible values: [postgres]

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    

Authorization

type: apiKeyname: Authtokenin: header

Request

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

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