PUT databases/:database_name

Creates a job to run the action specified by the action parameter against the database identified by :database_name. The :database_name is the value of the name field that the GET databases command returns.

Returns a job ID that you can use to determine the status of the job. See GET jobs.

Resource URL

https://<NODE>:5444/databases/:database_name

Authentication

Requires a VerticaAPIKey in the request header.

The API key must have normal level security or higher.

Parameters

user_id
 A database username. 
passwd
 A password for the username. 
action

Can be one of the following values:

  • start — Start the database.
  • stop — Stop the database.
  • rebalance — Rebalance the database.
  • Workload Analyzer — Run Work Load Analyzer against the database.

Example Request

PUT 
https://<NODE>:5444/databases/testDB?user_id=username&passwd=username_password&action=stop

Response: 

{
    "id": "StopDatabase-testDB-2014-07-20 13:28:49.321744",
    "url": "/jobs/StopDatabase-testDB-2014-07-20 13:28:49.321744"
}