Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

name path methods description
ClusterResourceV2
  • /api/v2/manager/cluster/status
  • /api/v2/manager/cluster/topology
  • GET
  • GET
ControlResourceV2
  • /api/v2/manager/control/service/{service}/fail
  • /api/v2/manager/control/service/{service}/failover
  • /api/v2/manager/control/service/{service}/heartbeat
  • /api/v2/manager/control/service/{service}/offline
  • /api/v2/manager/control/service/{service}/online
  • /api/v2/manager/control/service/{service}/promote
  • /api/v2/manager/control/service/{service}/recover
  • /api/v2/manager/control/service/{service}/shun
  • /api/v2/manager/control/service/{service}/switch
  • /api/v2/manager/control/service/{service}/welcome
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/backup
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/clearArchive
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/clearStandby
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/delete
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/fail
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/master
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/offline
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/online
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/promote
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/recover
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/relay
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/restore
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/setArchive
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/setStandby
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/shun
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/slave
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/welcome
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/master
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/offline
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/online
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/relay
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/slave
  • /api/v2/manager/control/service/{service}/datasource/{datasource}/{component}/{command}
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
ServiceResourceV2
  • /api/v2/manager/service/ping
  • /api/v2/manager/service/{service}/policy
  • /api/v2/manager/service/{service}/policy/{policy}
  • /api/v2/manager/service/{service}/router/status
  • /api/v2/manager/service/{service}/datasource/{datasource}/ping
  • GET
  • GET
  • POST
  • GET
  • GET
StatusResourceV2
  • /api/v2/manager/status
  • /api/v2/manager/status/service/{service}
  • /api/v2/manager/status/service/{service}/datasource/{datasource}
  • /api/v2/manager/status/composite/{composite}/service/{service}/datasource/{datasource}
  • GET
  • GET
  • GET
  • GET
TaskResourceV2
  • /api/v2/manager/tasks
  • /api/v2/manager/task/{taskId}
  • GET
  • GET

Data Types

JSON

type description
ApiException
BooleanPL
BooleanPayload
ClusterPolicyManagerMode
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
DatasourceStatusPayload Status of the datasource
Manager
Replicator
ResourceState
Router
Service Service
Service Service
ServiceStatusPayload Status of the service.
Status
StatusDataSource
StatusPayload Status payload.
StatusService
StringPL
StringPayload
TaskDesc
TaskPayload
TaskState
TungstenPayload