Skip to main content
Common Reference

Tungsten REST APIv2

Version availability

Available in 7.0.0 and later.

note

This documentation section refers to APIv2 for v7.x Tungsten Releases. To view documentation related to v8, please refer to "Tungsten REST APIv8"

Version 7.0.0 of the Tungsten suite of products introduces the Public RESTful API (Referred to as APIv2)

The API will allow quick and easy access to monitoring of all tungsten components, cluster manipulation and change of configuration for both humans and software.

A number of key development decisions were made to allow the release (APIv2). The choice was made to release with a high level of security by default, and a minimal set of features so we can release quickly. Future releases will build on this initial foundation:

  • Security First: the API is only enabled on localhost (127.0.0.1) by default. Additionally, SSL is now enabled by default (in previous releases, SSL was disabled by default).
  • User/Password Protection: HTTP Basic Auth is required to access most API calls. RBAC will come in a future version.
  • Per-layer API: each component has its own API.
  • Per-host instances: Passwords are stored securely on each host. Of course, the Tungsten installation tool (tpm) allows deployment of identical user/password pairs across nodes, as does the Tungsten Dashboard GUI.
  • The REST API provides read-only information through HTTP GET calls. Continuent has made the deliberate choice of using only POST actions when they affect the state or configuration of the software. The reason why we made that choice is a matter of simplification: there is an overlap between the definitions of PUT and POST, and the decision to chose between the two is often a balance with pros and cons, triggering sterile discussions. Rather than spending time debating and choosing, we decided to offer only one, so you will not find any use of PUT in our list of functions.

For the full developer documentation, listing all available calls, please refer to the following links:

Each layer of the product (Manager, Replicator, Proxy) has its own API, allowing for granular access and control of all operations.

warning

API calls triggering configuration changes are protected by a flag, i-am-sure=true, in order to avoid unwanted, potentially dramatic, configuration changes. This applies to:

  • configuration/module/servicesmap
  • reset
  • offline
  • online
  • onhold
  • addDataService
  • addDataSource