/en/connecting-to/management-api/general-api-information/ Recent content in General API information on OpenText Analytics Database 26.2.x Hugo -- gohugo.io /en/connecting-to/management-api/general-api-information/get/ Mon, 01 Jan 0001 00:00:00 +0000 /en/connecting-to/management-api/general-api-information/get/ <p>Returns API version information and a list of links to child resources for the Management API.</p> <h2 id="resource-url">Resource URL</h2> <pre tabindex="0"><code>https://&lt;NODE&gt;:5444/ </code></pre><h2 id="authentication">Authentication</h2> <p>Not required.</p> <h2 id="parameters">Parameters</h2> <p>None.</p> <h2 id="example-request">Example request</h2> <table class="table table-bordered" > <tr> <td > <strong>GET</strong></td> <td > <code>https://&lt;NODE&gt;:5444/</code></td></tr></table> <p><strong>Response:</strong></p> <pre tabindex="0"><code>{ &#34;body&#34;: { &#34;mime-types&#34;: [ &#34;default&#34;, &#34;application/vertica.database.configuration.json-v2&#34;, &#34;application/json&#34;, &#34;application/vertica.nodes.json-v2&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;application/vertica.jobs.json-v2&#34;, &#34;default&#34;, &#34;application/vertica.hosts.json-v2&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/vertica.hosts.json-v2&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;application/vertica.host.json-v2&#34;, &#34;default&#34;, &#34;application/vertica.hosts.json-v2&#34;, &#34;application/json&#34;, &#34;application/vertica.nodes.json-v2&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;application/vertica.database.json-v2&#34;, &#34;default&#34;, &#34;application/vertica.hosts.json-v2&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/vertica.hosts.json-v2&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;application/vertica.databases.json-v2&#34;, &#34;application/vertica.nodes.json-v2&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;application/vertica.agent.json-v2&#34;, &#34;default&#34;, &#34;application/json&#34;, &#34;default&#34;, &#34;application/vertica.users.json-v2&#34;, &#34;application/json&#34; ], &#34;version&#34;: &#34;7.1.0&#34; }, &#34;href&#34;: &#34;/&#34;, &#34;links&#34;: [ &#34;/databases&#34;, &#34;/hosts&#34;, &#34;/nodes&#34;, &#34;/licenses&#34;, &#34;/webhooks&#34;, &#34;/backups&#34;, &#34;/restore&#34;, &#34;/jobs&#34; ], &#34;mime-type&#34;: &#34;application/vertica.agent.json-v2&#34; } </code></pre> /en/connecting-to/management-api/general-api-information/get-api/ Mon, 01 Jan 0001 00:00:00 +0000 /en/connecting-to/management-api/general-api-information/get-api/ <p>Lists all Management API commands, with a brief description of each one and its parameters.</p> <h2 id="resource-url">Resource URL</h2> <pre tabindex="0"><code>https://<span class="code-variable">node-ip-address</span>:5444/api </code></pre><h2 id="authentication">Authentication</h2> <p>None</p> <h2 id="example">Example</h2> <pre tabindex="0"><code>$ curl -k https://10.20.100.247:5444/api [ { &#34;route&#34;: &#34;/&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;Returns the agent specific information useful for version checking and service discovery&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/api&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;build the list of cluster objects and properties and return it as a JSON formatted array&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/backups&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;list all the backups that have been created for all vbr configuration files ( *.ini ) that are located in the /opt/vertica/config directory.&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/backups/:config_script_base&#34;, &#34;method&#34;: &#34;POST&#34;, &#34;description&#34;: &#34;create a new backup as defined by the given vbr configuration script base (filename minus the .ini extenstion)&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/backups/:config_script_base/:archive_id&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;get the detail for a specific backup archive&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/backups/:config_script_base/:archive_id&#34;, &#34;method&#34;: &#34;DELETE&#34;, &#34;description&#34;: &#34;delete a backup based on the config ini file script&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/databases&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;build the list of databases, their properties, and current status (from cache) and return it as a JSON formatted array&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/databases&#34;, &#34;method&#34;: &#34;POST&#34;, &#34;description&#34;: &#34;Create a new database by supplying a valid set of parameters&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [ &#34;name : name of the database to create&#34;, &#34;passwd : password used by the database administrative user&#34;, &#34;only : optional list of hostnames to include in database&#34;, &#34;exclude : optional list of hostnames to exclude from the database&#34;, &#34;catalog : directory used for the vertica catalog&#34;, &#34;data : directory used for the initial vertica storage location&#34;, &#34;port : port the database will listen on (default 5433)&#34;, &#34;restart_policy : (optional) set restart policy&#34;, &#34;force_cleanup_on_failure : (optional) Force removal of existing directories on failure of command&#34;, &#34;force_removal_at_creation : (optional) Force removal of existing directories before creating the database&#34;, &#34;communal_storage_url : (optional) communal storage location for the database&#34;, &#34;num_shards : (optional) number of shared for databases with communal storage&#34;, &#34;depot_path : (optional, but if specified requires depot_size) path to a directory where files from communal storage can be locally cached&#34;, &#34;depot_size : (optional, required by depot_path) size of the depot. Examples: (\&#34;10G\&#34;, \&#34;2000M\&#34;, \&#34;1T\&#34;, \&#34;250K\&#34;)&#34;, &#34;aws_access_key_id: (optional)&#34;, &#34;aws_secret_access_key : (optional)&#34;, &#34;configuration_parameters : (optional) A string that is a serialized python-literal dictionary of configuration parameters set at bootstrap. &#39;{\&#34;kerberosservicename\&#34;:\&#34;verticakerb\&#34;}&#39;&#34;] }, { &#34;route&#34;: &#34;/databases/:database_name&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;Retrieve the database properties structure&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/databases/:database_name&#34;, &#34;method&#34;: &#34;PUT&#34;, &#34;description&#34;: &#34;Control / alter a database values using the PUT http method&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [&#34;action : value one of start|stop|rebalance|wla&#34;] }, { &#34;route&#34;: &#34;/databases/:database_name&#34;, &#34;method&#34;: &#34;DELETE&#34;, &#34;description&#34;: &#34;Delete an existing database&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [] }, { &#34;route&#34;: &#34;/databases/:database_name/configuration&#34;, &#34;method&#34;: &#34;GET&#34;, &#34;description&#34;: &#34;retrieve the current parameters from the database. if its running return 503 Service Unavailable&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [ &#34;user_id : vertica database username&#34;, &#34;passwd : vertica database password&#34;] }, { &#34;route&#34;: &#34;/databases/:database_name/configuration&#34;, &#34;method&#34;: &#34;PUT&#34;, &#34;description&#34;: &#34;set a list of parameters in the database. if its not running return 503 Service Unavailable&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [ &#34;user_id : vertica database username&#34;, &#34;passwd : vertica database password&#34;, &#34;parameter : value vertica parameter/key combo&#34;] }, ... { &#34;route&#34;: &#34;/webhooks/subscribe&#34;, &#34;method&#34;: &#34;POST&#34;, &#34;description&#34;: &#34;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&#34;, &#34;accepts&#34;: {}, &#34;params&#34;: [&#34;url : full url to the callback resource&#34;] } ] </code></pre>