GET api
Displays a list of all Management API commands and a brief description for each command. You can also access an HTML version of this information at https://<NODE>:5444/api.html
. Replace <NODE> with the URL of a cluster node.
Resource URL
https://<NODE>:5444/api
Authentication
Not required.
Parameters
None.
Example Request
GET |
https://<NODE>:5444/api |
Response:
[ { "accepts": {}, "description": " Returns the agent specific information useful for version checking and service discovery ", "method": "GET", "params": [], "route": "/" }, { "accepts": {}, "description": " build the list of cluster objects and properties and return it as a JSON formatted array ", "method": "GET", "params": [], "route": "/api" }, { "accepts": {}, "description": " list all the backups that have been created for all vbr configuration files ( *.ini ) that are located in the /opt/vertica/config directory. ", "method": "GET", "params": [], "route": "/backups" }, { "accepts": {}, "description": " create a new backup as defined by the given vbr configuration script base (filename minus the .ini extenstion) ", "method": "POST", "params": [], "route": "/backups/:config_script_base" }, { "accepts": {}, "description": " get the detail for a specific backup archive ", "method": "GET", "params": [], "route": "/backups/:config_script_base/:archive_id" }, { "accepts": {}, "description": " delete a backup based on the config ini file script", "method": "DELETE", "params": [], "route": "/backups/:config_script_base/:backup_id" }, { "accepts": {}, "description": " build the list of databases, their properties, and current status ( from cache ) and return it as a JSON formatted array ", "method": "GET", "params": [], "route": "/databases" }, { "accepts": {}, "description": " Create a new database by supplying a valid set of parameters ", "method": "POST", "params": [ "name : name of the database to create", "passwd : password used by the database administrative user", "only : optional list of hostnames to include in database", "exclude : optional list of hostnames to exclude from the database", "catalog : directory used for the vertica catalog", "data : directory used for the initial vertica storage location", "port : port the database will listen on (default 5433)" ], "route": "/databases" }, { "accepts": {}, "description": " Retrieve the database properties structure ", "method": "GET", "params": [], "route": "/databases/:database_name" }, { "accepts": {}, "description": " Control / alter a database values using the PUT http method ", "method": "PUT", "params": [ "action : value one of start|stop|rebalance|wla" ], "route": "/databases/:database_name" }, { "accepts": {}, "description": " Delete an existing database ", "method": "DELETE", "params": [], "route": "/databases/:database_name" }, { "accepts": {}, "description": " retrieve the current parameters from the database. if its running return 503 Service Unavailable ", "method": "GET", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/configuration" }, { "accepts": {}, "description": " set a list of parameters in the database. if its not running return 503 Service Unavailable ", "method": "PUT", "params": [ "user_id : vertica database username", "passwd : vertica database password", "parameter : value vertica parameter/key combo" ], "route": "/databases/:database_name/configuration" }, { "accepts": {}, "description": " list the hosts that are current used by this database", "method": "GET", "params": [], "route": "/databases/:database_name/hosts" }, { "accepts": {}, "description": " add a host to the database ", "method": "POST", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/hosts" }, { "accepts": {}, "description": " remove a host from the database", "method": "DELETE", "params": [], "route": "/databases/:database_name/hosts/:host_id" }, { "accepts": {}, "description": " start the database process on a specific host participating in this database.", "method": "POST", "params": [], "route": "/databases/:database_name/hosts/:host_id/process" }, { "accepts": {}, "description": " run the stop action against the given database for a specific host", "method": "DELETE", "params": [], "route": "/databases/:database_name/hosts/:host_id/process" }, { "accepts": {}, "description": " replace a host with a standby host in the database ", "method": "POST", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/hosts/:host_id/replace_with/:host_id_new" }, { "accepts": {}, "description": " return the vertica license that this database is using ", "method": "GET", "params": [ "user_id : vertica database user", "passwd : vertica databse password" ], "route": "/databases/:database_name/license" }, { "accepts": {}, "description": " this method upgrades the license in the database by using the license in /opt/vertica/config/share ", "method": "PUT", "params": [ "user_id : vertica database user", "passwd : vertica databse password" ], "route": "/databases/:database_name/license" }, { "accepts": {}, "description": " return all the feature licenses that this database is using ", "method": "GET", "params": [ "user_id : vertica database user", "passwd : vertica databse password" ], "route": "/databases/:database_name/licenses" }, { "accepts": {}, "description": " build the list of nodes for a given database, their properties, and current status ( from cache ) and return it as a JSON formatted array ", "method": "GET", "params": [], "route": "/databases/:database_name/nodes" }, { "accepts": {}, "description": " build the list of nodes for a given database, their properties, and current status and return it as a JSON formatted array ", "method": "GET", "params": [], "route": "/databases/:database_name/nodes/:node_id" }, { "accepts": {}, "description": " run the start action against the given database ", "method": "POST", "params": [ "epoch : start the database from this epoch", "include : start the database on these hosts only" ], "route": "/databases/:database_name/process" }, { "accepts": {}, "description": " easy way to see if a database is running -- returns state of UP or DOWN", "method": "GET", "params": [], "route": "/databases/:database_name/process" }, { "accepts": {}, "description": " run the stop action against the given database ", "method": "DELETE", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/process" }, { "accepts": {}, "description": " run the rebalance data action against the given database - could be very long running! ", "method": "POST", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/rebalance/process" }, { "accepts": {}, "description": " Retrieve the database properties structure ", "method": "GET", "params": [], "route": "/databases/:database_name/status" }, { "accepts": {}, "description": " run the analyze workload action against the given database - could be very long running! ", "method": "POST", "params": [ "user_id : vertica database username", "passwd : vertica database password" ], "route": "/databases/:database_name/wla/process" }, { "accepts": {}, "description": " build a list of nodes in the cluster independent of their database associations ", "method": "GET", "params": [], "route": "/hosts" }, { "accepts": {}, "description": " lists the properties of a given host in the cluster by calling the RESTful service on that agent. ", "method": "GET", "params": [], "route": "/hosts/:hostid" }, { "accepts": {}, "description": " Returns a list of jobs the agent is tracking along with their current status and exit codes ", "method": "GET", "params": [], "route": "/jobs" }, { "accepts": {}, "description": " Deletes a specific job by canceling any outstanding activity associated with it. ", "method": "DELETE", "params": [], "route": "/jobs/:id" }, { "accepts": {}, "description": " Returns the details (the saved output) for a specific job ", "method": "GET", "params": [], "route": "/jobs/:id" }, { "accepts": {}, "description": " POST your vertica license to this url using HTTP file upload format. ", "method": "POST", "params": [ "license : the file to upload (use html form post format)" ], "route": "/licenses" }, { "accepts": {}, "description": " list the license fiel that will be used by databases created on this cluster found in /opt/vertica/config/share/license.key ", "method": "GET", "params": [], "route": "/licenses" }, { "accepts": {}, "description": " build a list of nodes in the topology independent of their database associations ", "method": "GET", "params": [], "route": "/nodes" }, { "accepts": {}, "description": " build a list of nodes in the topology independent of their database associations ", "method": "GET", "params": [], "route": "/nodes/:nodeid" }, { "accepts": {}, "description": " restore a backup given then archive id as defined via the 'GET' method ", "method": "POST", "params": [], "route": "/restore/:archive_id" }, { "accepts": {}, "description": " delete a subscription from this agent. ", "method": "DELETE", "params": [], "route": "/webhooks/:subscriber_id" }, { "accepts": {}, "description": " post a request with a callback url to subscribe to events from this agent. Returns a subscription_id that can be used to unsubscribe from the service. @returns subscription_id ", "method": "POST", "params": [ "url : full url to the callback resource" ], "route": "/webhooks/subscribe" } ]