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
ReplicatorApi
  • /api/v2/replicator/offline
  • /api/v2/replicator/online
  • /api/v2/replicator/purge
  • /api/v2/replicator/reset
  • /api/v2/replicator/services
  • /api/v2/replicator/status
  • /api/v2/replicator/version
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
ServiceApi
  • /api/v2/replicator/service/{serviceName}/backup
  • /api/v2/replicator/service/{serviceName}/backupCapabilities
  • /api/v2/replicator/service/{serviceName}/backups
  • /api/v2/replicator/service/{serviceName}/check
  • /api/v2/replicator/service/{serviceName}/clear
  • /api/v2/replicator/service/{serviceName}/clients
  • /api/v2/replicator/service/{serviceName}/flush
  • /api/v2/replicator/service/{serviceName}/heartbeat
  • /api/v2/replicator/service/{serviceName}/offline
  • /api/v2/replicator/service/{serviceName}/online
  • /api/v2/replicator/service/{serviceName}/perf
  • /api/v2/replicator/service/{serviceName}/properties
  • /api/v2/replicator/service/{serviceName}/purge
  • /api/v2/replicator/service/{serviceName}/reset
  • /api/v2/replicator/service/{serviceName}/restore
  • /api/v2/replicator/service/{serviceName}/setrole
  • /api/v2/replicator/service/{serviceName}/status
  • /api/v2/replicator/service/{serviceName}/wait
  • /api/v2/replicator/service/{serviceName}/thl/compression
  • /api/v2/replicator/service/{serviceName}/thl/encryption
  • /api/v2/replicator/service/{serviceName}/thl/genkey
  • /api/v2/replicator/service/{serviceName}/thl/index
  • /api/v2/replicator/service/{serviceName}/thl/inflight-protocol
  • /api/v2/replicator/service/{serviceName}/thl/info
  • POST
  • GET
  • GET
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET POST
  • GET POST
  • POST
  • GET
  • GET POST
  • GET
TaskApi
  • /api/v2/replicator/tasks
  • /api/v2/replicator/task/{taskId}
  • GET
  • GET

Data Types

JSON

type description
ApiException
BackupCapabilities Backup capabilities
BackupCapabilitiesPayload Lists backup and storage capabilities as well as default backup and storage agents.
BackupDesc Backup settings.
BackupPayload Provides backup settings, if needed.
BackupsListPayload Lists of all existing backups.
BooleanPL
BooleanPayload
ClientsPayload Lists all connected THL clients.
ConsistencyCheckDesc Consistency check parameters
ConsistencyCheckPayload Provides consistency check settings.
DeferredType Type of deferred request
FileDesc File characteristics
FlushDesc Flush parameters
FlushPayload Provides flush settings.
LogIndexEntry Sortable index entry, where entries are sorted by sequence number.
OfflineDesc Offline parameters
OfflinePayload Provides offline settings, if needed.
OfflineType Type of offline request
OnlineDesc Online parameters
OnlineOption Provides a value for an online option type.
OnlineOptionType Type of online option
OnlinePayload Provides online settings, if needed.
PropertiesListPayload Lists service properties.
PurgeDesc
PurgePayload
RESET_TYPE Type of reset operation
ROLE Role of a service
ReplicatorPerfPayload Provides performance data of the service.
ReplicatorStatusByType Status of the given type per service
ReplicatorStatusByTypePayload Provides status of the replicator for a given type
ReplicatorStatusPayload Provides status of the replicator
ResetDesc
ResetPayload
RestoreDesc
RestorePayload
STATUS_TYPE Type of status (query parameter)
ServicePerf Service performance counters
ServiceStagePerf Stage performance counters
ServiceStatus Status of the service
ServiceStatusByType Status of the service for the given type
ServiceStatusByTypePayload Provides status of the service for a given type
ServiceStatusPayload Provides status of the service
ServicesPayload Provides a list of all services defined in this replicator
SetRoleDesc Parameters for SET ROLE operation
SetRolePayload Provides SET ROLE parameters
StorageSpecification Contains storage metadata.
StringPL
StringPayload
THLIndexPayload Provides THL index
THLInfo THL information
THLInfoPayload Provides THL general information
Task
TaskDesc
TaskPayload
TaskState
TasksPayload
TungstenPayload
WaitDesc
WaitPayload