OpsCenter API

The OpsCenter API facilitates the development of websites and programs to retrieve data and perform DataStax Enterprise database administrative actions. The OpsCenter API includes RESTful requests for programmatically performing the same set of operations as the OpsCenter GUI.

The documentation includes examples of each API method and is organized as follows:

authentication describes how to authenticate when users and roles are configured.
opscenter-config covers methods for getting information about clusters, such as seed hosts and the JMX port, adding a new cluster to OpsCenter, updating a cluster, and removing a cluster.
get-cluster-info describes methods for getting more information about clusters, such as the endpoint snitch and partitioner name, information about a particular cluster property, nodes in the cluster, and node properties.
node-ops describes methods for performing garbage compaction, flushing memtables, and other administrative actions on nodes and keyspaces.
managing-keyspace-cf describes keyspace and table operations, such as creating new keyspaces and tables.
new-get-perf-data explains how to measure the performance of clusters, nodes, and tables, as well as generate projected forecasts of performance.
events-alerts includes documentation about methods for getting information about events and alerts and setting alert rules.
schedules describes methods for dealing with scheduled operations. Currently the type of operations that can be scheduled is limited to backups and best practice rules
backups describes methods for running backups, getting information about existing backups, and restoring keyspaces and tables from backups.
best-practice describes methods for getting results of best practice rules as well as running individual rules on demand.
hadoop shows how to get information about the current status of the Hadoop infrastructure in your DSE cluster.
spark shows how to get information about the current status of the Spark infrastructure in your DSE cluster.
performance details methods for configuring the performance service and displaying results from it.
ui details method for interacting with various OpsCenter User Interface components.
agent details methods for installing agents, determining agent health and operations on a node.
lcm-overview describes how to provision clusters and manage their configurations.

This document contains the following sections:

.. toctree::
   :maxdepth: 2

   authentication
   opscenter_config
   cluster_info
   node_ops
   data_modeling
   metrics
   events_alerts
   schedules
   backups
   best_practice
   hadoop
   spark
   performance
   ui
   agent
   lcm_overview

.. toctree::
   :hidden:

   lcm_repository
   lcm_machine_credential
   lcm_config_profile
   lcm_definitions
   lcm_cluster
   lcm_datacenter
   lcm_node
   lcm_jobs
   lcm_walkthru