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
AdministrationResource
  • /rs/administration/connections
  • /rs/administration/connections/{sessionID}
  • GET
  • DELETE GET
REST resource that provides access to the current administration connections that are currently connected to the FileCatalystServer
ApplicationDiagnosticsResource
  • /rs/applicationDiagnostics
  • POST
REST resource that provides the ability for API consumers to access and create diagnostics packages for the application
AuthorizationSessionResource
  • /rs/AuthorizationSession
  • /rs/AuthorizationSession/{id}
  • POST
  • DELETE
Class to manage authorization session objects
AuthorizationSessionResourceRev1
  • /rs/AuthorizationSessionRev1
  • /rs/AuthorizationSessionRev1/{id}
  • GET POST
  • DELETE
Class to manage authorization sessions
CentralManagementResource
  • /rs/centralManagement
  • GET POST
Allows modification of central monitoring settings
CertificateResource
  • /rs/certificate
  • /rs/certificate/import
  • GET POST
  • POST
REST resource that is responsible for viewing, creating, and uploading SSL certificates to the FileCatalyst Server
ConfigPropertiesResource
  • /rs/config
  • /rs/config/{property}
  • GET POST PUT
  • DELETE GET POST
Allows users to retrieve, update, and add configuration values to the server
FCSessionRev1Resource
  • /rs/sessionsRev1
  • /rs/sessionsRev1/{sessionID}
  • /rs/sessionsRev1/{sessionID}/{clientID}
  • GET
  • GET
  • DELETE GET POST
Allows the listing of statistics for all sessions found in the system. This rest service is new and keeps backward compatibility, in order to create new resources to manage received sessions
FCSessionsResource
  • /rs/sessions
  • /rs/sessions/{sessionID}
  • DELETE GET
  • DELETE GET POST
Allow the listing of statistics for all sessions found in the system
FileSystemTestResource
  • /rs/filesystemTest
  • GET
REST entry point that can be used that can be used to test credentials and access parameters of external file systems that you wish to use in the application.

Tests from this resource currently performs the following operations:
  • Internal test to see if the file system is supported by the FileCatalyst software
  • Creation test to see if the file system can be created and loaded
  • Verification test to see if the root path of the FileSystem exists
  • Listing test to verify that the application can receive a proper listing from the file system
FileSystemsResource
  • /rs/filesystems
  • /rs/filesystems/{filesystem}
  • /rs/filesystems/{filesystem}/filelist
  • /rs/filesystems/{filesystem}/testFileSystem
  • /rs/filesystems/{filesystem}/filelist/{directory}
  • DELETE GET POST
  • DELETE GET POST
  • GET
  • GET
  • GET
Allows the retrieval of the list of filesystems and the addition of a new filesystem
FoldersResource
  • /rs/folders
  • /rs/folders/{folder}
  • /rs/folders/{folder}/link
  • /rs/folders/{folder}/unlink
  • /rs/folders/{folder}/link/permission
  • DELETE GET POST
  • DELETE GET POST
  • GET POST
  • POST
  • GET
REST service to allow the listing of folders and the adding of a new folder.
GraphImplResource
  • /rs/graph/agentrates
  • /rs/graph/clientsessionrates
  • /rs/graph/rates
  • /rs/graph/sessionrates
  • GET
  • GET
  • GET
  • GET
Graph Rest Class
GroupsResource
  • /rs/groups
  • /rs/groups/{group}
  • /rs/groups/{group}/link
  • /rs/groups/{group}/unlink
  • DELETE GET POST
  • DELETE GET POST
  • GET POST
  • POST
REST service to allow the listing of groups and the adding of a new group.
LicenseResource
  • /rs/license
  • GET POST
REST service to allow the listing and modification of the license string.
LocalResource
  • /rs/local
  • /rs/local/{directory}
  • GET POST
  • DELETE GET
Local file system resource that allows users to interact with the local file system of the server
LogFileImplResource
  • /rs/logfile/clientlog
  • /rs/logfile/clientsessionlog
  • /rs/logfile/masterlog
  • /rs/logfile/reveal
  • /rs/logfile/sessionlog
  • GET
  • GET
  • GET
  • GET
  • GET
REST service that allows users to retrieve the current logs for Server and the individual sessions that are currently connected.

Note: Most of these resources require that you supply an "adminID" as part of the REST call. This parameter is a unique value generated by the requester, and it will be used to keep the requester's session separate from the others.
LogsResource
  • /rs/logs
  • GET
Provides the user access to the logs of the application
OAuthResource
  • /rs/oauth/accessToken
  • /rs/oauth/accessURL
  • GET
  • GET
REST resource that provides access to OAuth authentication resources for various external file systems.

Note: OAuth is currently only supported by the Dropbox file system
ReportsResource
  • /rs/reports/bandwidth/export
  • /rs/reports/data/export
  • /rs/reports/periodic/export
  • GET
  • GET
  • GET
Allows access to Server's reports. Reports differ from logs in that reports are numerical statistics describing file and transfer characteristics. For example transfer rate, file size, transfer time, etc.
RunReportResource
  • /rs/runreport
  • GET POST
REST resource for running reports and collecting information from the Server
SMTPResource
  • /rs/smtp/testSMTP
  • POST
A REST Resource That Provides Consumers With The Ability To Perform Standard SMTP Based Operations
ServiceStatusResource
  • /rs/serviceStatus
  • DELETE GET POST
REST service that provides access to retrieving, modifying, and deletion of Server's status as a service
SpacesResource
  • /rs/spaces
  • POST
REST service to allow the listing of users and the adding of a new user.
SystemMonitorResource
  • /rs/systemMonitor
  • GET
REST resource used to provide access to the current Session and UsageData information for the Server
SystemPropertiesResource
  • /rs/system
  • /rs/system/{property}
  • GET POST PUT
  • DELETE GET POST
REST service that allows the retrieval and setting of system wide values
TemporaryUserResource
  • /rs/temporaryUser
  • POST
REST resource for temporary user operations
TrustedOriginsResource
  • /rs/trustedOrigins
  • GET PUT
REST service to provide retrieval or updating of origins trusted by WebServer for cross-origin request support.
UsageDataResource
  • /rs/usageData
  • GET
REST service that provides usage data information for the server
UsersResource
  • /rs/users
  • /rs/users/allowUpperCaseUsernames
  • /rs/users/purgeUpperCaseUsernames
  • /rs/users/{user}
  • /rs/users/{user}/connectionMessage
  • /rs/users/{user}/link
  • /rs/users/{user}/password
  • /rs/users/{user}/testDiskWrite
  • /rs/users/{user}/token
  • /rs/users/{user}/unblockUser
  • /rs/users/{user}/unlink
  • /rs/users/{user}/weblink
  • DELETE GET POST
  • POST
  • POST
  • DELETE GET POST
  • GET
  • GET POST
  • POST
  • GET
  • DELETE GET
  • GET
  • POST
  • POST
REST service to allow the listing of users and the adding of a new user.
VisualImplResource
  • /rs/visuals/client
  • GET
transfer visualization rest class.
WebSocketSessionResource
  • /rs/websockets/sessions
  • GET
REST resource that is responsible for handling all of the active WebSocket sessions that are connected to the Server. Currently this resource only contains methods
WeblinkAccessResource
  • /rs/weblink
  • /rs/weblink/{parameter}
  • /rs/weblink/{parameter}/{linkID}
  • /rs/weblink/{parameter}/{linkID}/heartbeat
  • GET
  • GET
  • GET
  • GET
REST service that will provide access to a given link.
WeblinksResource
  • /rs/weblinks
  • /rs/weblinks/serviceImage
  • /rs/weblinks/{linkID}
  • DELETE GET
  • GET POST
  • DELETE GET POST PUT
REST resource that allows users to interact with the currently stored links.