Skip to main content

Configure Backup Client PostgreSQL Instance

Select

SaaS
Customer Managed

This API creates Cloud Database Instance for PostgreSQL.

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

Use GET azuredb/postgresql/instance API to get the dbInstanceIdentifier and port.

Request Body

  • cloudAccount object required
  • id integer
  • name string
  • dbInstanceIdentifier string required

    Database name. Use Select Instance API to fetch this

  • endPoint string required

    Database endpoint or hostname

  • port integer required

    Database port

  • plan object required
  • id integer
  • name string
  • sslEnabled boolean

    Default is false

  • SSL_CA_Certificate string
  • database object required

    Database connection credentials

  • username string required

    DB user name

  • password string

    DB Password. Optional - Not needed if its AD User

Responses

OK


Schema
  • instance object
  • id integer
  • name string
POST /v4/azuredb/postgresql/instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

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

{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"region": {
"id": 0,
"name": "string"
},
"cloudAccount": {
"id": 0,
"name": "string"
},
"dbInstanceIdentifier": "string",
"endPoint": "string",
"port": 0,
"plan": {
"id": 0,
"name": "string"
},
"sslEnabled": true,
"SSL_CA_Certificate": "string",
"database": {
"username": "string",
"password": "string"
},
"backupGateways": [
{
"id": 0,
"name": "string"
}
]
}'