.. _index:

OpsCenter API
=============
The OpsCenter API facilitates the development of websites and programs to
retrieve data and perform Cassandra 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:

* :ref:`authentication` describes how to authenticate when users and roles are configured.
* :ref:`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.
* :ref:`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.
* :ref:`node-ops` describes methods for performing garbage compaction, flushing
  memtables, and other administrative actions on nodes and keyspaces.
* :ref:`managing-keyspace-cf` describes keyspace and column family operations, such as
  creating new keyspaces and column families.
* :ref:`new-get-perf-data` explains how to measure the performance of clusters, nodes,
  and column families, as well as generate projected forecasts of performance.
* :ref:`events-alerts` includes documentation about methods for getting information
  about events and alerts and setting alert rules.
* :ref:`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
* :ref:`backups` describes methods for running backups, getting information about existing
  backups, and restoring keyspaces and column families from backups.
* :ref:`best-practice` describes methods for getting results of best practice rules
  as well as running individual rules on demand.
* :ref:`hadoop` shows how to get information about the current status of the Hadoop
  infrastructure in your DSE cluster.
* :ref:`spark` shows how to get information about the current status of the Spark
  infrastructure in your DSE cluster.
* :ref:`performance` details methods for configuring the performance service and displaying
  results from it.
* :ref:`ui` details method for interacting with various OpsCenter User Interface components.
* :ref:`agent-status` details methods for determining agent health and operations on a node.
* :ref:`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_status
   lcm_overview

.. toctree::
   :hidden:
    
   lcm_repository
   lcm_machine_credential
   lcm_config_profile
   lcm_definitions
   lcm_cluster
   lcm_datacenter
   lcm_node
   lcm_jobs
   lcm_walkthru