DBaaS Postgresql

PostgreSQL, open-source database known for its wide range of features and popularity with developers.

Read more

create-dbaas-pg-connection-pool

Create a DBaaS PostgreSQL connection pool

POST /dbaas-postgres/{service-name}/connection-pool

Path parameters

• service-name in path (required)

Request body

• application/json
  • name (required) (string)
  • database-name (required) (string)
  • mode (string)
  • size (integer)
  • username (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-pg-connection-pool: golang | Python | Java

CLI: exo api create-dbaas-pg-connection-pool

update-dbaas-pg-connection-pool

Update a DBaaS PostgreSQL connection pool

PUT /dbaas-postgres/{service-name}/connection-pool/{connection-pool-name}

Path parameters

• service-name in path (required)
• connection-pool-name in path (required)

Request body

• application/json
  • database-name (string)
  • mode (string)
  • size (integer)
  • username (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for update-dbaas-pg-connection-pool: golang | Python | Java

CLI: exo api update-dbaas-pg-connection-pool

delete-dbaas-pg-connection-pool

Delete a DBaaS PostgreSQL connection pool

DELETE /dbaas-postgres/{service-name}/connection-pool/{connection-pool-name}

Path parameters

• service-name in path (required)
• connection-pool-name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-pg-connection-pool: golang | Python | Java

CLI: exo api delete-dbaas-pg-connection-pool

create-dbaas-pg-database

Create a DBaaS Postgres database

POST /dbaas-postgres/{service-name}/database

null

Path parameters

• service-name in path (required)

Request body

• application/json
  • database-name (required) (string)
  • lc-collate (string): Default string sort order (LC_COLLATE) for PostgreSQL database
  • lc-ctype (string): Default character classification (LC_CTYPE) for PostgreSQL database

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-pg-database: golang | Python | Java

CLI: exo api create-dbaas-pg-database

delete-dbaas-pg-database

Delete a DBaaS Postgres database

DELETE /dbaas-postgres/{service-name}/database/{database-name}

null

Path parameters

• service-name in path (required)
• database-name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-pg-database: golang | Python | Java

CLI: exo api delete-dbaas-pg-database

create-dbaas-postgres-user

Create a DBaaS Postgres user

POST /dbaas-postgres/{service-name}/user

null

Path parameters

• service-name in path (required)

Request body

• application/json
  • username (required) (string)
  • allow-replication (boolean)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-postgres-user: golang | Python | Java

CLI: exo api create-dbaas-postgres-user

delete-dbaas-postgres-user

Delete a DBaaS Postgres user

DELETE /dbaas-postgres/{service-name}/user/{username}

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-postgres-user: golang | Python | Java

CLI: exo api delete-dbaas-postgres-user

reveal-dbaas-postgres-user-password

Reveal the secrets of a DBaaS Postgres user

GET /dbaas-postgres/{service-name}/user/{username}/password/reveal

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • username (string): Postgres username
    • password (string): Postgres password

SDK reference for reveal-dbaas-postgres-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-postgres-user-password

reset-dbaas-postgres-user-password

Reset the credentials of a DBaaS Postgres user

PUT /dbaas-postgres/{service-name}/user/{username}/password/reset

If no password is provided one will be generated automatically.

Path parameters

• service-name in path (required)
• username in path (required)

Request body

• application/json
  • password (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for reset-dbaas-postgres-user-password: golang | Python | Java

CLI: exo api reset-dbaas-postgres-user-password

create-dbaas-service-pg

Create a DBaaS PostgreSQL service

POST /dbaas-postgres/{name}

null

Path parameters

• name in path (required)

Request body

• application/json
  • pgbouncer-settings (object): System-wide settings for pgbouncer. - schema details
  • backup-schedule (object) - schema details
  • variant (string)
  • integrations (array[object]): Service integrations to be enabled when creating the service. - schema details
  • timescaledb-settings (object): System-wide settings for the timescaledb extension - schema details
  • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • termination-protection (boolean): Service is protected against termination and powering off
  • fork-from-service (string)
  • synchronous-replication (string)
  • recovery-backup-time (string): ISO time of a backup to recover from for services that support arbitrary times
  • pglookout-settings (object): System-wide settings for pglookout. - schema details
  • maintenance (object): Automatic maintenance settings - schema details
  • admin-username (string): Custom username for admin user. This must be set only when a new service is being created.
  • version (string)
  • plan (required) (string): Subscription plan
  • work-mem (integer): Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).
  • shared-buffers-percentage (integer): Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
  • pg-settings (object) - schema details
  • admin-password (string): Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
  • migration (object): Migrate data from existing server - schema details

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-service-pg: golang | Python | Java

CLI: exo api create-dbaas-service-pg

get-dbaas-service-pg

Get a DBaaS PostgreSQL service

GET /dbaas-postgres/{name}

Get a DBaaS PostgreSQL service

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • pgbouncer-settings (object): System-wide settings for pgbouncer. - schema details
    • updated-at (string): Service last update timestamp (ISO 8601)
    • node-count (integer): Number of service nodes in the active plan
    • connection-info (object): PG connection information properties - schema details
    • backup-schedule (object): Backup schedule - schema details
    • node-cpu-count (integer): Number of CPUs for each node
    • prometheus-uri (object): Prometheus integration URI - schema details
    • integrations (array[object]): Service integrations - schema details
    • zone (string): The zone where the service is running
    • node-states (array[object]): State of individual service nodes - schema details
    • name (string)
    • connection-pools (array[object]): PostgreSQL PGBouncer connection pools - schema details
    • type (string)
    • state (string)
    • timescaledb-settings (object): System-wide settings for the timescaledb extension - schema details
    • databases (array[string]): List of PostgreSQL databases
    • ip-filter (array[string]): Allowed CIDR address blocks for incoming connections
    • backups (array[object]): List of backups for the service - schema details
    • termination-protection (boolean): Service is protected against termination and powering off
    • notifications (array[object]): Service notifications - schema details
    • components (array[object]): Service component information objects - schema details
    • synchronous-replication (string)
    • pglookout-settings (object): System-wide settings for pglookout. - schema details
    • maintenance (object): Automatic maintenance settings - schema details
    • disk-size (integer): TODO UNIT disk space for data storage
    • node-memory (integer): TODO UNIT of memory for each node
    • uri (string): URI for connecting to the service (may be absent)
    • uri-params (object): service_uri parameterized into key-value pairs
    • version (string): PostgreSQL version
    • created-at (string): Service creation timestamp (ISO 8601)
    • plan (string): Subscription plan
    • work-mem (integer): Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).
    • shared-buffers-percentage (integer): Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
    • pg-settings (object) - schema details
    • max-connections (integer): Maximum number of connections allowed to an instance
    • users (array[object]): List of service users - schema details

SDK reference for get-dbaas-service-pg: golang | Python | Java

CLI: exo api get-dbaas-service-pg

update-dbaas-service-pg

Update a DBaaS PostgreSQL service

PUT /dbaas-postgres/{name}

Update a DBaaS PostgreSQL service

Path parameters

• name in path (required)

Request body

• application/json
  • pgbouncer-settings (object): System-wide settings for pgbouncer. - schema details
  • backup-schedule (object) - schema details
  • variant (string)
  • timescaledb-settings (object): System-wide settings for the timescaledb extension - schema details
  • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • termination-protection (boolean): Service is protected against termination and powering off
  • synchronous-replication (string)
  • pglookout-settings (object): System-wide settings for pglookout. - schema details
  • maintenance (object): Automatic maintenance settings - schema details
  • version (string): Version
  • plan (string): Subscription plan
  • work-mem (integer): Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).
  • shared-buffers-percentage (integer): Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.
  • pg-settings (object) - schema details
  • migration (object): Migrate data from existing server - schema details

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for update-dbaas-service-pg: golang | Python | Java

CLI: exo api update-dbaas-service-pg

delete-dbaas-service-pg

Delete a Postgres service

DELETE /dbaas-postgres/{name}

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-service-pg: golang | Python | Java

CLI: exo api delete-dbaas-service-pg

Other Operations

start-dbaas-pg-maintenance

Initiate PostgreSQL maintenance update

PUT /dbaas-postgres/{name}/maintenance/start

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for start-dbaas-pg-maintenance: golang | Python | Java

CLI: exo api start-dbaas-pg-maintenance

stop-dbaas-pg-migration

Stop a DBaaS PostgreSQL migration

POST /dbaas-postgres/{name}/migration/stop

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for stop-dbaas-pg-migration: golang | Python | Java

CLI: exo api stop-dbaas-pg-migration

create-dbaas-pg-upgrade-check

POST /dbaas-postgres/{service}/upgrade-check

Check whether you can upgrade Postgres service to a newer version

Path parameters

• service in path (required)

Request body

• application/json
  • target-version (required) (string)

Responses

• 200: 200
  • application/json
    • id (string)
    • create-time (string)
    • result (string)
    • result-codes (array[object]) - schema details
    • success (boolean)
    • task-type (string)

SDK reference for create-dbaas-pg-upgrade-check: golang | Python | Java

CLI: exo api create-dbaas-pg-upgrade-check

update-dbaas-postgres-allow-replication

Update access control for one service user

PUT /dbaas-postgres/{service-name}/user/{username}/allow-replication

null

Path parameters

• service-name in path (required)
• username in path (required)

Request body

• application/json
  • allow-replication (boolean)

Responses

• 200: 200
  • application/json
    • users (array[object]) - schema details

SDK reference for update-dbaas-postgres-allow-replication: golang | Python | Java

CLI: exo api update-dbaas-postgres-allow-replication

get-dbaas-settings-pg

Get DBaaS PostgreSQL settings

GET /dbaas-settings-pg

Get DBaaS PostgreSQL settings

Responses

• 200: 200
  • application/json
    • settings (object) - schema details

SDK reference for get-dbaas-settings-pg: golang | Python | Java

CLI: exo api get-dbaas-settings-pg