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
    oneOf
  • region object required
  • id integer
  • name string
  • 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

  • backupGateways object[]

    List of backupGateways or AccessNodes for Azure DB backup

    Optional : Not required if the directCloudBackup is set to true

  • id integer

    Backup Gateway ID

  • name string

    Backup Gateway Name

Responses

OK

Schema
  • instance object
  • id integer
  • name string
Loading...