Resources

name path methods description
ClusterResourceV8
  • /api/v8/manager/cluster/ping
  • /api/v8/manager/cluster/status
  • /api/v8/manager/cluster/topology
  • GET
  • GET
  • GET
ControlResourceV8
  • /api/v8/manager/services/{service}/datasources
  • /api/v8/manager/services/{service}/datasources/{datasource}/archive
  • /api/v8/manager/services/{service}/datasources/{datasource}/backup
  • /api/v8/manager/services/{service}/datasources/{datasource}/drain
  • /api/v8/manager/services/{service}/datasources/{datasource}/promote
  • /api/v8/manager/services/{service}/datasources/{datasource}/recover
  • /api/v8/manager/services/{service}/datasources/{datasource}/replicator/role
  • /api/v8/manager/services/{service}/datasources/{datasource}/replicator/state
  • /api/v8/manager/services/{service}/datasources/{datasource}/restore
  • /api/v8/manager/services/{service}/datasources/{datasource}/role
  • /api/v8/manager/services/{service}/datasources/{datasource}/standby
  • /api/v8/manager/services/{service}/datasources/{datasource}/state
  • /api/v8/manager/services/{service}/datasources/{datasource}/welcome
  • /api/v8/manager/services/{service}/datasources/{datasource}/{component}/{command}
  • /api/v8/manager/services/{service}/failover
  • /api/v8/manager/services/{service}/heartbeat
  • /api/v8/manager/services/{service}/promote
  • /api/v8/manager/services/{service}/recover
  • /api/v8/manager/services/{service}/state
  • /api/v8/manager/services/{service}/switch
  • /api/v8/manager/services/{service}/welcome
  • GET
  • GET PUT
  • POST
  • PUT
  • PUT
  • PUT
  • GET PUT
  • GET PUT
  • POST
  • GET PUT
  • GET PUT
  • GET PUT
  • PUT
  • GET PUT
  • POST
  • POST
  • PUT
  • PUT
  • GET PUT
  • POST
  • PUT
ServiceResourceV8
  • /api/v8/manager/services
  • /api/v8/manager/services/{service}/datasources/{datasource}/connections
  • /api/v8/manager/services/{service}/datasources/{datasource}/ping
  • /api/v8/manager/services/{service}/policy
  • /api/v8/manager/services/{service}/routers
  • GET
  • GET
  • GET
  • GET PUT
  • GET
StatusResourceV8
  • /api/v8/manager/quorum
  • /api/v8/manager/services/{service}/datasources/{datasource}/status
  • /api/v8/manager/services/{service}/status
  • /api/v8/manager/status
  • GET
  • GET
  • GET
  • GET
TaskResourceV8
  • /api/v8/manager/tasks
  • /api/v8/manager/tasks/{task-id}
  • GET
  • GET

Data Types

JSON

type description
ApiException
BooleanPL Boolean payload
BooleanPayload Boolean value
ClusterPolicyManagerMode Policy mode defines how the dataservice management system responds to different events and operations within the dataservice
ClusterStatus
ClusterStatusPayload Cluster status payload.
ClusterTopology
ClusterTopology
ClusterTopologyPayload Cluster topology payload.
Connections
ControlCommand
ControlCommandPayload Payload returned by service commands start/stop/restart/tail.
DataServer
DataSourceAlertStatus
Datasource Datasource
Datasource Datasource
DatasourceConnections
DatasourceConnectionsPayload Routers map payload.
DatasourceStatusPayload Status of the datasource
Manager
Quorum
QuorumStatusPayload Common Tungsten API payload
Replicator
ResourceState
Router
Service Service
Service Service
ServiceStatusPayload Status of the service.
Status
StatusDataSource
StatusPayload Status payload.
StatusService
StringPL String payload.
StringPayload String payload for configuration values, simple descriptions or command results. The string is embedded in a superclass so that the json structure will look like:
{
    "payloadType": "StringPayload",
    "payloadVersion": "1",
    "payload": 
    {
       "value"="stringvalue"
    }
}
Task
TaskDesc Payload containing a task.
TaskPayload Returns a task.
TaskState
TasksPayload Common Tungsten API payload
TungstenPayload Common Tungsten API payload