Resources

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

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
  • /databaseInstances
  • /deadlockDump
  • /handlers
  • /nodeRecoveryDetails
  • /restart
  • /shutdown
  • /threaddump
  • /backup/platform
  • /backup/topology
  • GET
  • GET
  • POST
  • GET
  • POST
  • GET
  • PUT
  • POST
  • POST
  • POST
  • POST
  • POST
ApplicationResource REST endpoints for the system-wide application properties.
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
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.
GerritLFSCacheResourceAuth
  • /lfs-cache
  • /lfs-cache/replicationgroup/{id}
  • /lfs-cache/repository/{id}
  • /lfs-cache/repositoryname/{name}
  • GET POST
  • GET POST
  • POST
  • POST
GerritLFSInfoResourceAuth
  • /lfs-info/repository/{id}
  • /lfs-info/repositoryname/{name}
  • /lfs-info/repository/{id}/count
  • /lfs-info/repositoryname/{name}/count
  • /lfs-info/replicationgroup/{id}/object/{oid}
  • /lfs-info/repository/{id}/object/{oid}
  • /lfs-info/repositoryname/{name}/object/{oid}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
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
LoggingResource
  • /log4j/level
  • GET PUT
LoggingResource REST endpoint to access and manipulate the system logging level
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}/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 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
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/count
  • /repositories/ecosystem
  • /repositories/failed
  • /repositories/search
  • /repositories/ecosystem/count
  • /repositories/filtered/count
  • GET
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
RepositoriesResource REST endpoint to access and manipulate collections of Repository data. Copyright 2012 WANdisco.
RepositoryResource
  • /repository
  • /repository/deleteRepository
  • /repository/search
  • /repository/setHead
  • /repository/stophelperall
  • /repository/update-config
  • /repository/{repositoryId}
  • /repository/{repositoryId}/config
  • /repository/{repositoryId}/consistencycheck
  • /repository/{repositoryId}/fork_repository
  • /repository/{repositoryId}/git-gc
  • /repository/{repositoryId}/history
  • /repository/{repositoryId}/nodeCount
  • /repository/{repositoryId}/prepareToUnsideline
  • /repository/{repositoryId}/removeSkipThreshold
  • /repository/{repositoryId}/replicationGroup
  • /repository/{repositoryId}/size
  • /repository/{repositoryId}/skipThreshold
  • /repository/{repositoryId}/startinput
  • /repository/{repositoryId}/startoutput
  • /repository/{repositoryId}/stats
  • /repository/{repositoryId}/stophelper
  • /repository/{repositoryId}/stopoutput
  • /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}
  • POST
  • DELETE
  • GET
  • PUT
  • PUT
  • PUT
  • DELETE GET
  • GET
  • GET POST
  • POST
  • POST
  • GET
  • GET
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
Application REST endpoint to access and manipulate specific Repository data.
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
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