+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods for interacting with the databases endpoints
+https://www.vultr.com/api/#tag/databases
+
+
+
+
+
++https://www.vultr.com/api/#tag/databases
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 1 +
+
+
+
+
+
+
+
+
Methods
+ + + + + + + +createConnectionPool()
+ + + + + + +
+ Create a new connection pool within the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/create-connection-pool +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/create-connection-pool +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 660 +
+
+
+
+
+
+
+
+
createDatabase()
+ + + + + + +
+ Create a new Managed Database in your account.
+https://www.vultr.com/api/#operation/create-database +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/create-database +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 43 +
+
+
+
+
+
+
+
+
createDatabaseDb()
+ + + + + + +
+ Create a new logical database within the Managed Database (MySQL and PostgreSQL only).
+https://www.vultr.com/api/#operation/create-database-db +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/create-database-db +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 306 +
+
+
+
+
+
+
+
+
createDatabaseUser()
+ + + + + + +
+ Create a new database user within the Managed Database.
+https://www.vultr.com/api/#operation/create-database-user +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/create-database-user +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 180 +
+
+
+
+
+
+
+
+
databaseAddReadReplica()
+ + + + + + +
+ Create a read-only replica node for the Managed Database.
+https://www.vultr.com/api/#operation/database-add-read-replica +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/database-add-read-replica +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 530 +
+
+
+
+
+
+
+
+
databaseDetachMigration()
+ + + + + + +
+ Detach a migration from the Managed Database.
+https://www.vultr.com/api/#operation/database-detach-migration +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/database-detach-migration +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 510 +
+
+
+
+
+
+
+
+
databaseFork()
+ + + + + + +
+ Fork a Managed Database to a new subscription from a backup.
+https://www.vultr.com/api/#operation/database-fork +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/database-fork +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 605 +
+
+
+
+
+
+
+
+
databaseRestoreFromBackup()
+ + + + + + +
+ Create a new Managed Database from a backup.
+https://www.vultr.com/api/#operation/database-restore-from-backup +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/database-restore-from-backup +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 578 +
+
+
+
+
+
+
+
+
databaseStartMigration()
+ + + + + + +
+ Start a migration to the Managed Database.
+https://www.vultr.com/api/#operation/database-start-migration +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/database-start-migration +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 464 +
+
+
+
+
+
+
+
+
deleteConnectionPool()
+ + + + + + +
+ Delete a connection pool within a Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/delete-connection-pool +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/delete-connection-pool +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 754 +
+
+
+
+
+
+
+
+
deleteDatabase()
+ + + + + + +
+ Delete a Managed Database.
+https://www.vultr.com/api/#operation/delete-database +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/delete-database +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 140 +
+
+
+
+
+
+
+
+
deleteDatabaseDb()
+ + + + + + +
+ Delete a logical database within a Managed Database (MySQL and PostgreSQL only).
+https://www.vultr.com/api/#operation/delete-database-db +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/delete-database-db +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 355 +
+
+
+
+
+
+
+
+
deleteDatabaseUser()
+ + + + + + +
+ Delete a database user within a Managed Database.
+https://www.vultr.com/api/#operation/delete-database-user +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/delete-database-user +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 261 +
+
+
+
+
+
+
+
+
getBackupInformation()
+ + + + + + +
+ Get backup information for the Managed Database.
+https://www.vultr.com/api/#operation/get-backup-information +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/get-backup-information +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 558 +
+
+
+
+
+
+
+
+
getConnectionPool()
+ + + + + + +
+ Get information about a Managed Database connection pool (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/get-connection-pool +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/get-connection-pool +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 700 +
+
+
+
+
+
+
+
+
getDatabase()
+ + + + + + +
+ Get information about a Managed Database.
+https://www.vultr.com/api/#operation/get-database +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/get-database +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 87 +
+
+
+
+
+
+
+
+
getDatabaseDb()
+ + + + + + +
+ Get information about a logical database within a Managed Database (MySQL and PostgreSQL only).
+https://www.vultr.com/api/#operation/get-database-db +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/get-database-db +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 330 +
+
+
+
+
+
+
+
+
getDatabaseUser()
+ + + + + + +
+ Get information about a Managed Database user.
+https://www.vultr.com/api/#operation/get-database-user +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/get-database-user +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 207 +
+
+
+
+
+
+
+
+
listAdvancedOptions()
+ + + + + + +
+ List all configured and available advanced options for the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/list-advanced-options +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-advanced-options +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 779 +
+
+
+
+
+
+
+
+
listAvailableVersions()
+ + + + + + +
+ List all available version upgrades within the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/list-available-versions +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-available-versions +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 863 +
+
+
+
+
+
+
+
+
listConnectionPools()
+ + + + + + +
+ List all connection pools within the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/list-connection-pools +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-connection-pools +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 640 +
+
+
+
+
+
+
+
+
listDatabaseDbs()
+ + + + + + +
+ List all logical databases within the Managed Database (MySQL and PostgreSQL only).
+https://www.vultr.com/api/#operation/list-database-dbs +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-database-dbs +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 286 +
+
+
+
+
+
+
+
+
listDatabaseUsers()
+ + + + + + +
+ List all database users within the Managed Database.
+https://www.vultr.com/api/#operation/list-database-users +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-database-users +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 160 +
+
+
+
+
+
+
+
+
listDatabases()
+ + + + + + +
+ List all Managed Databases in your account.
+https://www.vultr.com/api/#operation/list-databases +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-databases +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 25 +
+
+
+
+
+
+
+
+
listMaintenanceUpdates()
+ + + + + + +
+ List all available version upgrades within the Managed Database.
+https://www.vultr.com/api/#operation/list-maintenance-updates +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-maintenance-updates +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 380 +
+
+
+
+
+
+
+
+
listPlans()
+ + + + + + +
+ List Managed Database Plans.
+https://www.vultr.com/api/#operation/list-database-plans +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-database-plans +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 7 +
+
+
+
+
+
+
+
+
listServiceAlerts()
+ + + + + + +
+ List service alert messages for the Managed Database.
+https://www.vultr.com/api/#operation/list-service-alerts +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/list-service-alerts +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 420 +
+
+
+
+
+
+
+
+
startMaintenanceUpdates()
+ + + + + + +
+ Start maintenance updates for the Managed Database.
+https://www.vultr.com/api/#operation/start-maintenance-updates +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/start-maintenance-updates +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 400 +
+
+
+
+
+
+
+
+
startVersionUpgrade()
+ + + + + + +
+ Start a version upgrade for the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/start-version-upgrade +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/start-version-upgrade +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 883 +
+
+
+
+
+
+
+
+
updateAdvancedOptions()
+ + + + + + +
+ Updates an advanced configuration option for the Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/update-advanced-options +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/update-advanced-options +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 799 +
+
+
+
+
+
+
+
+
updateConnectionPool()
+ + + + + + +
+ Update connection-pool information within a Managed Database (PostgreSQL engine types only).
+https://www.vultr.com/api/#operation/update-connection-pool +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/update-connection-pool +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 725 +
+
+
+
+
+
+
+
+
updateDatabase()
+ + + + + + +
+ Update information for a Managed Database.
+https://www.vultr.com/api/#operation/update-database
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 107 +
+
+
+
+
+
+
+
+
updateDatabaseUser()
+ + + + + + +
+ Update database user information within a Managed Database.
+https://www.vultr.com/api/#operation/update-database-user +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/update-database-user +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 232 +
+
+
+
+
+
+
+
+
viewMigrationStatus()
+ + + + + + +
+ View the status of a migration attached to the Managed Database.
+https://www.vultr.com/api/#operation/view-migration-status +
+
+
+
+
+
+
+
+
+
+
+
+
+
++https://www.vultr.com/api/#operation/view-migration-status +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + databases.js, line 444 +
+
+
+
+
+
+
+
+