Resources

name path methods description
ReplicatorApiV8
  • /api/v8/replicator/offline
  • /api/v8/replicator/online
  • /api/v8/replicator/purge
  • /api/v8/replicator/reset
  • /api/v8/replicator/state
  • /api/v8/replicator/status
  • /api/v8/replicator/version
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET
Replicator management V8 API
ServiceApiV8
  • /api/v8/replicator/services
  • /api/v8/replicator/services/{service}/backup
  • /api/v8/replicator/services/{service}/backup-capabilities
  • /api/v8/replicator/services/{service}/backups
  • /api/v8/replicator/services/{service}/check
  • /api/v8/replicator/services/{service}/clients
  • /api/v8/replicator/services/{service}/configuration
  • /api/v8/replicator/services/{service}/dynamic-properties
  • /api/v8/replicator/services/{service}/flush
  • /api/v8/replicator/services/{service}/heartbeat
  • /api/v8/replicator/services/{service}/offline
  • /api/v8/replicator/services/{service}/online
  • /api/v8/replicator/services/{service}/perf
  • /api/v8/replicator/services/{service}/purge
  • /api/v8/replicator/services/{service}/reset
  • /api/v8/replicator/services/{service}/restore
  • /api/v8/replicator/services/{service}/role
  • /api/v8/replicator/services/{service}/state
  • /api/v8/replicator/services/{service}/status
  • /api/v8/replicator/services/{service}/thl/compression
  • /api/v8/replicator/services/{service}/thl/encryption
  • /api/v8/replicator/services/{service}/thl/genkey
  • /api/v8/replicator/services/{service}/thl/index
  • /api/v8/replicator/services/{service}/thl/inflight-protocol
  • /api/v8/replicator/services/{service}/thl/info
  • /api/v8/replicator/services/{service}/wait
  • GET
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • DELETE
  • PUT
  • POST
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • POST
  • PUT
  • GET
  • GET
  • GET PUT
  • GET PUT
  • POST
  • GET
  • GET PUT
  • GET
  • PUT
Services management V8 API
TaskApiV8
  • /api/v8/replicator/tasks
  • /api/v8/replicator/tasks/{task-id}
  • GET
  • GET
Tasks management V8 API

Data Types

JSON

type description
ApiException
BackupCapabilities Backup capabilities
BackupCapabilitiesPayload Lists backup and storage capabilities as well as default backup and storage agents.
BackupDescriptor BACKUP parameters payload.
BackupPayload Provides backup settings, if needed.
BackupsListPayload Lists of all existing backups.
BooleanPL Boolean payload
BooleanPayload Boolean value
ClientsPayload Lists all connected THL clients.
ConsistencyCheckDescriptor CHECK parameters payload.
ConsistencyCheckPayload Provides consistency check settings.
DeferredType Type of deferred offline request
FileDesc THL File characteristics
FlushDescriptor FLUSH parameters payload.
FlushPayload Provides flush settings.
LogIndexEntry THL index entry
OfflineDescriptor OFFLINE parameters payload.
OfflinePayload Provides offline settings, if needed.
OfflineType Type of offline request
OnlineDescriptor ONLINE parameters payload.
OnlineOption Provides a value for an online option type.
OnlineOptionType Type of online option
OnlinePayload Provides online settings, if needed.
PropertiesListPayload Lists service properties.
PurgeDescriptor PURGE parameters payload.
PurgePayload Provides purge settings.
RESET_TYPE Type of reset operation
ROLE Role of a service
ReplicatorPerfPayloadV8 Provides performance data of the service, when it is online. When not online, the payload will display the current state as shown:
 {
   "payloadType": "ReplicatorPerfPayloadV8",
   "payloadVersion": "1",
   "payload": {
     "uptime": 25.458,
     "status": "State: Safely Offline for 25.458s"
   }
 }
 
ReplicatorStatePayload Provides a list of states of all services defined in this replicator.
ReplicatorStatusPayload Provides status of the replicator
ResetDescriptor RESET parameters payload.
ResetPayload Provides reset settings.
RestoreDescriptor RESTORE parameters payload.
RestorePayload Provides restore settings.
ServicePerfV8 Service performance counters
ServiceStagePerfV8 Performance counters by stage and for each stage by tasks
ServiceState State of the service.
ServiceStatePayload Provides state of the service.
ServiceStatus Status of the service
ServicesPayload Provides a list of all services defined in this replicator
SetRoleDescriptor ROLE parameters payload.
SetRolePayload Provides role parameters
StorageSpecification Contains storage metadata.
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"
    }
}
THLIndexPayload Provides THL index
THLInfo THL information
THLInfoPayload Provides THL general information
Task
TaskDesc Payload containing a task.
TaskPayload Returns a task.
TaskState
TasksPayload Common Tungsten API payload
TungstenPayload Common Tungsten API payload
WaitDescriptor WAIT parameters payload.
WaitPayload Provides wait settings.