Create instance

Select

SaaS

Customer Managed

This API creates AWS PaaS Database Instance for PostgreSQL or Aurora PostgreSQL.

All the databases in the PostgreSQL instance will be backed up after creation.

application/json

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. The cluster writer/reader endpoint must be mentioned for Aurora instances.
SAUser object required
userName string
Database username
password string
Database password in base 64 encoded format
cloudDBEngineType string required
Possible values: [AURORA_POSTGRESQL, POSTGRESQL]
sslOpt object
sslEnabled boolean
Default is false
sslCa string
Path to SSL CA file on the Access Node
planEntity object required
planName string
Name of the Plan
dbEngine string required
Possible values: [postgres, aurora-postgresql]

Responses

application/json
application/xml
multipart/form-data
text/html
text/plain

Schema
Example (from schema)
Success

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": 214,
      "instanceName": "awspgdb14[us-east-1]",
      "instanceId": 80,
      "_type_": 0
    }
  }
}

Schema
Example (from schema)

Schema

object

<root/>

Schema
Example (from schema)

Schema

object

{}

Schema
Example (from schema)

Schema

object

{}

Schema
Example (from schema)

Schema

object

{}

Internal Server Error

application/json

Schema
Example (from schema)
Failure

Schema

errorMessage string
errorCode integer
entity object
subclientId integer
clientId integer
instanceName string
instanceId integer
_type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Connection to PostgreSQL Server failed.\n[~Connection to Database Failed: could not connect to server: Connection timed out (0x0000274C/10060)\tIs the server running on host \"x.x.x.x\" and accepting\tTCP/IP connections on port 5432?~]",
  "errorCode": 4444,
  "entity": {
    "subclientId": 0,
    "clientId": 214,
    "instanceName": "jah-pg14[us-east-2]",
    "instanceId": 2,
    "_type_": 0
  }
}

POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

Body

Default
PostgreSQL
Aurora PostgreSQL

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 125,
      "clientName": "string"
    },
    "version": "string",
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "cloudDBEngineType": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "postgres"
  }
}

Accept

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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "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": "AURORA_POSTGRESQL",
      "sslOpt": {
        "sslEnabled": true,
        "sslCa": "string"
      }
    },
    "planEntity": {
      "planName": "string"
    },
    "dbEngine": "postgres"
  }
}'

Create instance​

Authorization

Request

Create instance