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.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AdvancedLoggingResource
  • /logger/level
  • /logger/levels
  • /logger/loggers
  • /logger/reload
  • /logger/reset
  • /logger/save
  • /logger/{logger}
  • /logger/level/global
  • /logger/level/package
  • /logger/reset/logger
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • PUT
  • PUT
  • POST
AdvancedLoggingResource REST endpoint to access and manipulate the system logging level SWAGGER CONTRACT: https://app.swaggerhub.com/apis/WANdisco/logging/1.0.0
ApplicationResource
  • /agreementStatistics
  • /backup
  • /deadlockDump
  • /handlers
  • /nodeRecoveryDetails
  • /restart
  • /shutdown
  • /threaddump
  • GET
  • GET
  • POST
  • POST
  • GET
  • PUT
  • POST
  • POST
  • POST
Copyright 2013 WANdisco.
AuthoritiesResource
  • /security/ldap/authorities
  • GET
AuthorityResource
  • /security/ldap/authority
  • /security/ldap/authority/moveDownOrder
  • /security/ldap/authority/moveUpOrder
  • /security/ldap/authority/testConnection
  • /security/ldap/authority/update
  • DELETE GET POST
  • POST
  • POST
  • POST
  • PUT
BeaconsResource
  • /beacons
  • GET
BeaconsResource REST endpoint to access Beacon data.
ConfigurationResource
  • /configuration
  • /configuration/replicated
  • GET PUT
  • DELETE GET PUT
Copyright 2013 WANdisco.
ContentDistributionResource
  • /contentdistribution/filebased/all
  • /contentdistribution/filebased/dsm/{identity}
  • GET
  • GET
DelegateResource
  • /delegate
  • /delegate/start
  • /delegate/stop
  • GET
  • POST
  • POST
Copyright 2012 WANdisco.
DestinationsResource
  • /notification/channel/{channelName}/destinations
  • GET
REST end point to manipulate collections of channel-specific notification destinations.
EmailDestinationResource
  • /notification/channel/email/destination
  • /notification/channel/email/destination/{identity}
  • POST
  • DELETE GET PUT
REST end point to manipulate individual channel-specific notification destinations.
EmailGatewayResource
  • /notification/channel/email/gateway
  • /notification/channel/email/gateway/{identity}
  • /notification/channel/email/gateway/{gatewayId}/sendEmail/{destinationId}
  • POST
  • DELETE GET PUT
  • PUT
REST end point to manipulate individual channel-specific notification gateways.
EmailTemplateResource
  • /notification/channel/email/template
  • /notification/channel/email/template/{identity}
  • POST
  • DELETE GET PUT
REST end point to manipulate individual channel-specific notification templates.
FileReplicationResource
  • /file_replication
  • GET POST
Public API to FileReplication. Currently support GET but this is for testing, could be dropped.
GatewaysResource
  • /notification/channel/{channelName}/gateways
  • GET
REST end point to manipulate collections of channel-specific notification gateways.
KerberosConfigResource
  • /security/kerberos/canEnableSso
  • /security/kerberos/configuration
  • /security/kerberos/enableSso
  • /security/kerberos/isSsoEnabled
  • GET
  • GET PUT
  • POST
  • GET
REST end point for manipulating Kerberos and SSO configuration.
LicenseResource
  • /license
  • /license/UserAccountCognizance
  • /license/reload
  • /license/updateUserAccountCognizance
  • /license/user/{username}
  • GET
  • GET
  • PUT
  • POST
  • DELETE PUT
LicenseResource REST endpoint to access and manipulate specific licensing data.

Copyright 2013 WANdisco.

LocationResource
  • /location/{locationIdentity}
  • /location/{locationIdentity}/attributes
  • /location/{locationIdentity}/nodes
  • /location/{locationIdentity}/startIgnoring/{ignoreLocationIdentity}
  • GET PUT
  • GET PUT
  • GET
  • PUT
LocationResource REST endpoint to access and manipulate specific Location data.
LocationsResource
  • /locations
  • /locations/local
  • GET
  • GET PUT
LocationsResource REST endpoint to access and manipulate collections of Location data.
LogResource
  • /logging
  • /logging/levels
  • /logging/reload
  • /logging/save
  • /logging/package/{packageName}
  • GET
  • GET
  • PUT
  • POST
  • DELETE GET POST PUT
Copyright 2013 WANdisco.
LoggingResource
  • /log4j/level
  • GET PUT
LoggingResource REST endpoint to access and manipulate the system logging level
MembershipResource
  • /membership/{membershipId}
  • /membership/{membershipId}/availableacceptors
  • /membership/{membershipId}/availablelearners
  • GET
  • GET
  • GET
MembershipResource REST endpoint to access and manipulate com.wandisco.nodes.groups.Membership data.
MembershipsResource
  • /memberships
  • GET
Copyright 2013 WANdisco.
MonitorResource
  • /monitor
  • /monitor/{monitorId}
  • /monitor/{monitorId}/addCondition
  • /monitor/{monitorId}/removeCondition
  • POST PUT
  • DELETE GET
  • POST
  • PUT
Rest Resource containing various end-points regarding system resource monitoring (disk, ram, etc.), to access and manipulate lists of objects associated with resource monitoring data.
MonitorsResource
  • /monitors
  • /monitors/count
  • /monitors/monitoringInterval
  • GET
  • GET
  • GET
Resource monitoring REST endpoint to access and manipulate lists of objects associated with resource monitoring data.
NodeResource
  • /node/{nodeIdentity}
  • /node/{nodeIdentity}/attributes
  • /node/{nodeIdentity}/informCount
  • /node/{nodeIdentity}/membership
  • /node/{nodeIdentity}/membershipfris
  • /node/{nodeIdentity}/name
  • /node/{nodeIdentity}/statemachines
  • /node/{nodeIdentity}/attributes/delete
  • /node/{nodeIdentity}/ecosystem/removenodes
  • /node/{nodeIdentity}/removeNode/{nodeIdToRemove}
  • /node/{nodeIdentity}/statemachine/{dsmId}
  • /node/{nodeIdentity}/membership/{membershipIdentity}/attributes
  • /node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput
  • /node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered
  • /node/{nodeIdentity}/statemachine/{dsmId}/lastoutput
  • /node/{nodeIdentity}/statemachine/{dsmId}/membership
  • /node/{nodeIdentity}/statemachine/{dsmId}/prepareToUnsideline
  • /node/{nodeIdentity}/statemachine/{dsmId}/sideline
  • /node/{nodeIdentity}/statemachine/{dsmId}/startoutput
  • /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput
  • /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput
  • /node/{nodeIdentity}/statemachine/{dsmId}/unsideline
  • /node/{nodeIdentity}/system/removenodeall/{nodeIdentityToRemove}
  • /node/{nodeIdentity}/membership/{membershipIdentity}/attributes/delete
  • /node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}
  • /node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeIdToRemove}
  • /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove
  • /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set
  • GET PUT
  • DELETE GET PUT
  • GET
  • POST
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • POST
  • DELETE GET
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • DELETE
  • PUT
  • PUT
NodeResource REST endpoint to access and manipulate specific Node data.
NodeResource
  • /node/{nodeIdentity}
  • /node/{nodeIdentity}/get-node-ecosystem-dsm
  • /node/{nodeIdentity}/pendingTransactions
  • /node/{nodeIdentity}/pendingTransactionsByPassCache
  • /node/{nodeIdentity}/removenodes
  • /node/{nodeIdentity}/start-node-ecosystem-output
  • /node/{nodeIdentity}/stop-node-ecosystem-output
  • /node/{nodeIdentity}/setNodeName/{nodeName}
  • GET PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
Platform translation API for Node operations
NodesResource
  • /nodes
  • /nodes/local
  • /nodes/removed
  • GET
  • GET
  • GET
NodesResource REST endpoint to access and manipulate collections of Node data.
ReconfigurationResource
  • /reconfiguration/node
  • DELETE
Copyright 2014 WANdisco
ReplicationGroupResource
  • /replicationGroup
  • /replicationGroup/query
  • /replicationGroup/{replicationGroupId}
  • /replicationGroup/{replicationGroupId}/addNewNodes
  • /replicationGroup/{replicationGroupId}/emergencyReconfiguration
  • /replicationGroup/{replicationGroupId}/managingNode
  • /replicationGroup/{replicationGroupId}/membershipRotation
  • /replicationGroup/{replicationGroupId}/name
  • /replicationGroup/{replicationGroupId}/schedule
  • /replicationGroup/{replicationGroupId}/node/{nodeId}
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • POST
  • PUT
  • PUT
  • PUT
  • PUT
  • DELETE
The REST interface that allows access to and manipulation of an individual com.wandisco.application.replicationGroup.ReplicationGroup.
ReplicationGroupsResource
  • /replicationGroups
  • /replicationGroups/allReplicationGroupsAssociatedWithNodeId
  • /replicationGroups/allUniqueReplicationGroupsAssociatedWithDsmIds
  • /replicationGroups/allUniqueReplicationGroupsAssociatedWithNodes
  • GET
  • GET
  • GET
  • GET
The REST interface that allows access to and manipulation of com.wandisco.application.replicationGroup.ReplicationGroups.
ReplicationGroupsResource
  • /replicationGroups
  • /replicationGroups/allUniqueReplicationGroupsAssociatedWithNodes
  • /replicationGroups/allUniqueReplicationGroupsAssociatedWithRepositoryIds
  • /replicationGroups/search
  • /replicationGroups/{replicationGroupId}
  • /replicationGroups/{replicationGroupId}/addNewNodes
  • /replicationGroups/{replicationGroupId}/removeNodes
  • /replicationGroups/{replicationGroupId}/schedule
  • /replicationGroups/{replicationGroupId}/groupName/{name}
  • /replicationGroups/{replicationGroupId}/managingNode/{managingNodeId}
  • /replicationGroups/{replicationGroupId}/node/{nodeId}
  • /replicationGroups/{replicationGroupId}/scheduleSuspended/{suspended}
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET
  • POST
  • PUT
  • PUT
  • PUT
  • PUT
  • DELETE
  • PUT
This class also has a new @Path param defined as "replicationGroups" where as the older version is using the @Path param replication-groups. This class and the older version of "ReplicationGroupsResource" now both extend a base class called "ReplicationGroupsResourceBase", the rational for this change was to move all the common code used by both classes to a single class and then have both the new and old version of "ReplicationGroupsResource" make calls to the "ReplicationGroupsResourceBase" and pass the version of the "VCSReplicationGroupListDTO" that is required.
ReplicatorResource
  • /replicator/coordinatedstartall
  • /replicator/coordinatedstopall
  • /replicator/coordinatedstopallprogress
  • /replicator/emergencyReconfiguration
  • /replicator/startall
  • /replicator/stopall
  • /replicator/systemState
  • /replicator/systemStatus
  • /replicator/diagnostic-mode/{diagnosticMode}
  • /replicator/startIgnoringLocation/{ignoreLocationIdentity}
  • /replicator/systemStatus/hideAbortedTasks
  • /replicator/systemStatus/hideSevereLogs
  • /replicator/systemStatus/hideWarningLogs
  • /replicator/systemStatus/itemAgeThreshold
  • /replicator/systemStatus/pollingInterval
  • /replicator/systemStatus/itemAgeThreshold/{newThreshold}
  • /replicator/systemStatus/pollingInterval/{newPollingInterval}
  • PUT
  • PUT
  • GET
  • POST
  • PUT
  • PUT
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • PUT
  • PUT
Platform translation API for Backup operations
RepositoriesResource
  • /repositories
  • /repositories/consistencyCheck
  • /repositories/consistencyCheckQuantity
  • /repositories/count
  • /repositories/ecosystem
  • /repositories/failed
  • /repositories/globalConsistencyCheck
  • /repositories/scheduledConsistencyCheckEnabled
  • /repositories/scheduledConsistencyCheckFrequency
  • /repositories/search
  • /repositories/svnClearCache
  • /repositories/ecosystem/count
  • /repositories/scheduledConsistencyCheckEnabled/{enabled}
  • /repositories/scheduledConsistencyCheckFrequency/{frequency}
  • /repositories/{revisionQuantity}/consistencyCheckQuantity
  • GET
  • POST
  • GET
  • GET
  • GET
  • DELETE
  • POST
  • GET
  • GET
  • GET
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
RepositoriesResource REST endpoint to access and manipulate collections of Repository data. Copyright 2012 WANdisco.
RepositoryResource
  • /repository
  • /repository/create
  • /repository/search
  • /repository/stophelperall
  • /repository/{repositoryId}
  • /repository/{repositoryId}/clearTxnBlocks
  • /repository/{repositoryId}/clearTxnBlocksLocalNode
  • /repository/{repositoryId}/consistencyCheck
  • /repository/{repositoryId}/history
  • /repository/{repositoryId}/nodeCount
  • /repository/{repositoryId}/prepareToUnsideline
  • /repository/{repositoryId}/removeSkipThreshold
  • /repository/{repositoryId}/repairTxnSequence
  • /repository/{repositoryId}/replicationGroup
  • /repository/{repositoryId}/size
  • /repository/{repositoryId}/skipThreshold
  • /repository/{repositoryId}/startoutput
  • /repository/{repositoryId}/stophelper
  • /repository/{repositoryId}/stopoutput
  • /repository/{repositoryId}/txn
  • /repository/{repositoryId}/uncoordinated-stopoutput
  • /repository/{repositoryId}/unsideline
  • /repository/{repositoryId}/globalReadOnly/{readOnly}
  • /repository/{repositoryId}/lastdelivered/{nodeName}
  • /repository/{repositoryId}/lastkey/{nodeName}
  • /repository/{repositoryId}/lastoutput/{nodeName}
  • /repository/{repositoryId}/localReadOnly/{readOnly}
  • /repository/{repositoryId}/replicationGroup/{replicationGroupId}
  • /repository/{repositoryId}/skipThreshold/{key}
  • /repository/{repositoryId}/txn/acquireBlock
  • /repository/{repositoryId}/txn/failedBlocks
  • /repository/{repositoryId}/txn/removeBlocks
  • /repository/{repositoryId}/txn/failedBlocks/removeBlocks
  • /repository/{repositoryId}/txn/removeBlock/identity/{identity}
  • POST
  • POST
  • GET
  • PUT
  • DELETE GET
  • PUT
  • PUT
  • POST
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
Application REST endpoint to access and manipulate specific Repository data.
RouterResource
  • /router
  • /router/disable
  • /router/enable
  • POST
  • PUT
  • PUT
Copyright 2016 WANdisco.
RoutersResource
  • /routers
  • GET
Copyright 2013 WANdisco.
RoutesResource
  • /routes
  • /routes/addRoutes
  • /routes/deleteRoutes
  • GET
  • PUT
  • PUT
Copyright 2013 WANdisco.
RuleResource
  • /notification/rule
  • /notification/rule/{identity}
  • POST
  • DELETE GET PUT
REST end point to manipulate individual notification rules.
RulesResource
  • /notification/channels
  • /notification/events
  • /notification/rules
  • GET
  • GET
  • GET
REST end point to manipulate collections of notification rules, notification delivery channel implementations and notifiable events.
SecuritySettingsResource
  • /security/settings/checkSecuritySettingsForConflicts
  • /security/settings/export
  • /security/settings/import
  • POST
  • POST
  • POST
StateMachineResource
  • /statemachine/{dsmId}
  • GET
Copyright 2013 WANdisco.
StateMachinesResource
  • /statemachines/coordinatedstartall
  • /statemachines/coordinatedstopall
  • /statemachines/emergencyReconfiguration
  • /statemachines/startalluncoordinateoutput
  • /statemachines/stopalluncoordinateoutput
  • PUT
  • PUT
  • POST
  • PUT
  • PUT
Copyright 2013 WANdisco.
TaskResource
  • /task/{taskId}
  • /task/{taskId}/abort
  • /task/{taskId}/force
  • /task/{taskId}/withchildren
  • DELETE GET
  • PUT
  • DELETE
  • GET
TaskResource REST endpoint to access and manipulate specific task data.
TasksResource
  • /tasks
  • /tasks/aborted
  • /tasks/pending
  • GET
  • GET
  • GET
TasksResource REST endpoint to access and manipulate collections of Task data.
TemplatesResource
  • /notification/channel/{channelName}/templates
  • GET
REST end point to manipulate collections of channel-specific notification templates.
UserResource
  • /security/user
  • /security/user/{userName}
  • POST
  • DELETE GET PUT
REST end point for manipulating individual internally managed users.
UsersResource
  • /security/users
  • /security/users/canDisableManagedUsers
  • /security/users/disableManagedUsers
  • /security/users/isManagedUsersDisabled
  • GET
  • GET
  • POST
  • GET
REST end point for manipulating lists of internally managed users and managed users authentication provider enablement.
UtilResource
  • /utils/heapStatus
  • GET
TestingResource REST endpoint to access details relevant to testing Copyright 2017 WANdisco.

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.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
LoginController
  • /login
  • GET POST
Provides custom pages for the Spring Security login and logout end points.