OpenText Analytics Database 26.2.x – Rest APIs for the agent

Connecting-To: VerticaAPIKey

Mon, 01 Jan 0001 00:00:00 +0000

The Management API requires an authentication key, named VerticaAPIKEY, to access some API resources. You can manage API keys by using the apikeymgr command-line tool.

usage: apikeymgr [-h] [--user REQUESTOR] [--app APPLICATION] [--delete]
                 [--create] [--update] [--migrate]
                 [--secure {restricted,normal,admin}] [--list]

API key management tool

optional arguments:
  -h, --help            show this help message and exit
  --user REQUESTOR      The name of the person requesting the key
  --app APPLICATION     The name of the application that will use the key
  --delete              Delete the key for the given R & A
  --create              Create a key for the given R & A
  --update              Update a key for the given R & A
  --migrate             migrate the keyset to the latest format
  --secure {restricted,normal,admin}
                        Set the keys security level
  --list                List all the keys known

Example request

To create a new VerticaAPIKEY for the dbadmin user with admin access, enter the following:

$ apikeymgr --user dbadmin --app vertica --create --secure admin

Response:

Requestor  : dbadmin
Application: vertica
API Key    : ValidAPIKey
Synchronizing cluster...

Connecting-To: Backup and restore

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to perform backup and restore tasks for your database.

GET backups	Returns all the backups that have been created for all vbr configuration files ( *.ini ) that are located in the `/opt/vertica/config` directory.
POST backups/:config_script_base	Creates a new backup as defined by the given vbr configuration script base (filename without the .ini extension).
GET backups/:config_script_base/:archive_id	Returns details for a specific backup archive.
POST restore/:archive_id	Restores a backup.

Connecting-To: Databases

Mon, 01 Jan 0001 00:00:00 +0000

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.

Connecting-To: Hosts

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to get information on the hosts in your cluster.

GET hosts	Returns a list of hosts in this cluster.
GET hosts/:hostid	Returns details for a specific host in this cluster.

Connecting-To: Jobs

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to get information on your database's jobs.

GET jobs	Returns a list of jobs the agent is tracking, along with their current status and exit codes.
GET jobs/:id	Returns the details (the saved output) for a specific job.

Connecting-To: Licenses

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to manage licenses for your database.

POST licenses	Uploads and applies a new license to this cluster.
GET licenses	Returns the license field that databases created on this cluster use.

Connecting-To: Nodes

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to retrieve information on the nodes in your cluster.

GET nodes	Returns a list of nodes in this cluster.
GET nodes/:nodeid	Returns details for a specific node in this cluster.

Connecting-To: Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

You can use these API calls to obtain information on, create, or delete webhooks.

GET webhooks	Returns a list of active webhooks.
POST webhooks/subscribe	Creates a new webhook.
DELETE webhooks/:subscriber_id	Deletes an existing webhook.