Databases
You can use these API calls to interact with your database.
You can use these API calls to interact with your database.
| GET databases | Returns a list of databases, their properties, and current status. |
| POST databases | Creates a new database by supplying a valid set of parameters. |
| GET databases/:database_name | Returns details about a specific database. |
| PUT databases/:database_name | Starts, stops, rebalances, or runs Workload Analyzer on a database. |
| DELETE databases/:database_name | Deletes an existing database. |
| GET databases/:database_name/configuration | Returns the current configuration parameters from the database. |
| PUT databases/:database_name/configuration | Sets one or more configuration parameters in the database. |
| GET databases/:database_name/hosts | Returns hosts details for a specific database. |
| POST databases/:database_name/hosts | Adds a new host to the database. |
| DELETE databases/:database_name/hosts/:host_id | Removes a host from the database. |
| POST databases/:database_name/hosts/:host_id/process | Starts the database process on a specific host. |
| DELETE databases/:database_name/hosts/:host_id/process | Stops the database on a specific host. |
| POST databases/:database_name/hosts/:host_id/replace_with/:host_id_new | Replaces a host with a standby host in the database. |
| GET databases/:database_name/license | Returns the Vertica license that the specified database is using. |
| GET databases/:database_name/licenses | Returns all the feature licenses that the specified database is using. |
| GET databases/:database_name/nodes | Returns a list of nodes for the specified database. |
| GET databases/:database_name/nodes/:node_id | Returns details on a specific node for the specified database. |
| POST databases/:database_name/process | Starts the specified database. |
| GET databases/:database_name/process | Returns the state of the database as either UP or DOWN. |
| DELETE databases/:database_name/process | Stops the specified database on all hosts. |
| POST databases/:database_name/rebalance/process | Rebalances the specified database. This option can have a long run time. |
| GET databases/:database_name/status [broken] | Retrieves the database properties structure. |
| POST databases/:database_name/Workload Analyzer/process | Runs the analyze workload action against the specified database.This option can have a long run time. |
In this section
- GET databases
- POST databases
- GET databases/:database_name
- PUT databases/:database_name
- DELETE databases/:database_name
- GET databases/:database_name/configuration
- PUT databases/:database_name/configuration
- GET databases/:database_name/hosts
- POST databases/:database_name/hosts
- DELETE databases/:database_name/hosts/:host_id
- POST databases/:database_name/hosts/:host_id/process
- GET databases/:database_name/license
- GET databases/:database_name/licenses
- DELETE databases/:database_name/hosts/:host_id/process
- POST databases/:database_name/hosts/:host_id/replace_with/:host_id_new
- GET databases/:database_name/nodes
- GET databases/:database_name/nodes/:node_id
- POST databases/:database_name/process
- GET databases/:database_name/process
- DELETE databases/:database_name/process
- POST databases/:database_name/rebalance/process
- POST databases/:database_name/Workload analyzer/process