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
CommandResource
  • /rs/agent/command
  • POST
Allows commands to be input to FC Server at a lower level. FC Server has commands that operate at level just above the UDP layer. It is these commands that are executed during this call. As of July 18th, 2017, there is only one allowed command available to TransferAgent, the SITE command. The SITE command allows users to execute chown or chmod commands on files on an instance of FCServer
ConfigPropertiesResource
  • /rs/agent/config
  • /rs/agent/config/{property}
  • GET POST
  • DELETE GET POST
Allows users to read and set multiple TransferAgent configuration values. This call can be used to set all configurations seen at the TransferAgent config page https://localhost.filecatalyst.net:12680/config.html
ConnectResource
  • /rs/agent/connect
  • /rs/agent/connect/connectivityTest
  • /rs/agent/connect/siteConnection
  • /rs/agent/connect/{connectionKey}
  • /rs/agent/connect/connectivityTest/{connectionKey}
  • /rs/agent/connect/{connectionKey}/removeKey
  • GET POST
  • GET
  • GET
  • DELETE
  • GET
  • DELETE
Connects TransferAgent to a given instance of FCServer. There are four resource available: a standard connection request, a connection request to FCWeb, a connection to FCWeb TwoWay feature, and finally a connection using the FC site feature. Important to note that "connect" is one of two REST services that provide a connection key for a given set of connection parameters. "Connect" is different from the other connection service, "register", in that it immediately tests the connection to the server. This means that the connection to the server must be established before the response of this call is returned. The connection code returned by this REST call is used in a large set of the REST services that TransferAgent provides. Any REST calls that directly interact with a server will use the connection code in order to determine which server the client is trying to connect to.
CurrentAgentImplResource
  • /rs/agent/currentagent/clientsfromsession
  • /rs/agent/currentagent/clientsfromtask
  • /rs/agent/currentagent/sessions
  • /rs/agent/currentagent/tasks
  • GET
  • GET
  • GET
  • GET
Retrieves a list of task and session information. A task is defined here as predetermined transfer; parameters such as an execution time, the files to transfer, the destination, max bandwidth, packet size, etc. are all set. This group of established transfer settings makes up a task. A session represents the current transfer taking place. A session can represent the transfer of a single file, or the transfer of a group of files. A group of files transfered will have the same session ID.
GraphImplResource
  • /rs/agent/graph/agentrates
  • /rs/agent/graph/clientrates
  • /rs/agent/graph/rates
  • /rs/agent/graph/sessionrates
  • /rs/agent/graph/taskrates
  • GET
  • GET
  • GET
  • GET
  • GET
Returns all data points and values of a given data set necessary in order to construct a graph of said data. Used to update UIs and the front end. Each of calls below return a list of rates in terms of a different search criteria. The "segmentCount" parameter in each call represents the number of time segments the requester wishes to record data for. The default value for the length of a time segment is 1 second. If the segmentCount is set to 7 for example, the desired rates will be recorded for 7 seconds and the data collected over that period will be returned to the requester. The list returned is a list of TransmitRateTimeSliceModel objects. Each objects corresponds with one time segment, meaning that if you enter 7 in your segmentCount parameter, you will receive a list of 7 TransmitRateTimeSliceModel objects. The returned list will be arranged in ascending chronological order, meaning the earliest time slices will be displayed first. Information on the model and the data that gets returned can be found in the description of TransmitRateTimeSliceModel
HeartbeatResource
  • /rs/agent/heartbeat
  • GET
Detects whether or not the TA is running.
HttpInterfaceResource
  • /rs/agent/httpinterface
  • GET POST PUT
Retrieves and modifies list of network interfaces used to access TransferAgent. Allows the specification of a single or multiple addresses that can be to communicate to TransferAgent
LicenseResource
  • /rs/agent/license
  • DELETE GET POST
Allows retrieval/modification of the TransferAgent license. The current license can be retrieved or a new one supplemented.
LocalFileResource
  • /rs/files/localfile
  • /rs/files/localfile/{file}
  • DELETE POST
  • DELETE GET POST PUT
Allows modification of files stored on the TransferAgent host machine. Files can be renamed, moved, deleted, or have the details retrieved. Note that for any of the follow calls that requires a file path to be entered, if virtual roots are enabled, then any supplied file must have a valid virtual root.
LocalResource
  • /rs/files/local
  • /rs/files/local/filter
  • /rs/files/local/{directory}
  • GET
  • POST
  • GET

Similar to /files/localfile/ and /agent/path, this resource retrieves the file listing form the local machine.

Note: The difference between this resource and /agent/path is that this resource will list all virtual paths as file roots, if there is one or more virtual path declared inside of TransferAgent. If there are not virtual paths declared, this resource will return the default file roots.

Note: The difference between this resource and the /files/localfile/ is that this resource cannot perform any file operations, just retrieve file listings. Some calls under this resource use the "sortby" parameter, which takes one of four inputs: "name", "size", "lastmodified", and "type". The "type" parameter sorts files by their extension,

LogFileImplResource
  • /rs/agent/logfile/clientlog
  • /rs/agent/logfile/clientsessionlog
  • /rs/agent/logfile/masterlog
  • /rs/agent/logfile/sessionlog
  • GET
  • GET
  • GET
  • GET
Retrieves logs from TransferAgent. This is one of two resources used to retrieve TransferAgent logs, but this resource should be used over the other. There are four methods used to retrieve logs. Each method uses a different criteria to filter the results. The four filters are; clients IDs, client session IDs, session IDs, and a master filter, which returns all available logs
LogsResource
  • /rs/agent/logs
  • /rs/agent/logs/postClearLog
  • /rs/agent/logs/postTwoWayLogsToFCWeb
  • GET
  • GET
  • POST
Retrieves logs from TransferAgent. This is an older resource that should be avoided if possible. It is still used by FileCatalyst Express, but it is slowly being phased out.
OriginsResource
  • /rs/agent/origins
  • GET POST PUT
Allows users to retrieve, update and add origins to the TA's origin list
PathResource
  • /rs/agent/path
  • /rs/agent/path/{directory}
  • GET
  • GET
Retrieves the local file listing. This call will not list any virtual files
RegistrationResource
  • /rs/agent/register
  • /rs/agent/register/{connectionKey}
  • GET POST
  • DELETE
Allows TransferAgent to connect to a server without actually establishing a connection until it is needed. Any "on connect" actions such as creating a directory will not be performed. The connection test will be done when the next transfer to the supplied server is started
RemoteAuthorizationResource
  • /rs/agent/remoteControlAuthorization
  • /rs/agent/remoteControlAuthorization/{id}
  • GET POST
  • DELETE
Resource that allows the user to authenticate for a Remotely Controlled session in the TransferAgent.

Note: This REST resource only functions when the 'Remote Control' feature is enabled within the TransferAgent's currently license key. If the option isn't currently enabled, then calls to this resource will reply with RESTFault objects.
RemoteFileResource
  • /rs/files/remotefile
  • /rs/files/remotefile/{file}
  • DELETE GET POST
  • DELETE GET POST PUT
Allows access and modification of remote files. "Remote" in this case means files and directories stored on an instance of FCServer. Remote file listings can be retrieved and files can be renamed or deleted. Remote directories can be created. For all calls, file paths are given relative to the selected FCServer user's root directory. The user is selected based on the connection key supplied
RemoteResource
  • /rs/files/remote
  • /rs/files/remote/{directory}
  • GET
  • GET
Retrieves file listings from a users directory from an instance of FCServer. The "sortby" and "invert" parameters described here function the in the same way as calls to the localfile resource. The "sortby" parameter takes one of four inputs: "name", "size", "lastmodified", and "type". The "type" parameter sorts files by their extension.
ReportsResource
  • /rs/agent/reports
  • GET POST
Allows access to TransferAgent'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. Logs are textual descriptions of TransferAgent's activities.
RevealResource
  • /rs/agent/reveal
  • GET
Opens a file explorer on the host machine of TransferAgent. This resource will fail if TransferAgent is installed as a service
ServiceResource
  • /rs/agent/serviceStatus
  • DELETE GET POST
Controls TransferAgent's status as a service. Allows TransferAgent to be installed or uninstalled as a service. Also allows TransferAgent to be enabled or disabled. Services must be enabled before they are allowed to be started upon startup of the host machine
ShutdownResource
  • /rs/agent/shutdown
  • GET
Allows the shutdown of the TransferAgent.
SiteStatusResource
  • /rs/agent/siteStatus/{siteID}
  • /rs/agent/siteStatus/connectivityTest/{siteID}
  • GET
  • GET
Allows retrieval of the status of sites associated with TransferAgent
SitesResource
  • /rs/agent/sites
  • /rs/agent/sites/{site}
  • DELETE GET POST
  • DELETE GET POST
Allows modification of the FC sites feature. FC sites are groups of data representing a connection to a given instance of an FCServer. Sites store connection information, supported features, and transfer settings defaults
StatusResource
  • /rs/agent/status
  • /rs/agent/status/{transferid}
  • GET POST
  • GET
Retrieves the status of TransferAgent transfers
SystemPropertiesResource
  • /rs/agent/system
  • /rs/agent/system/{property}
  • GET PUT
  • DELETE GET POST
Allows users to read and set host machine system configuration values
TasksResource
  • /rs/agent/tasks
  • /rs/agent/tasks/{task}
  • GET POST
  • DELETE GET POST
Allows retrieval, creation, and modification of tasks. FC tasks are groups of data representing preconfigured transfers. Tasks store information such as a schedule to perform the transfer, a source and destination, and transfer settings (bandwidth, packet size, etc)
TransferResource
  • /rs/files/transfer
  • /rs/files/transfer/cancel
  • POST
  • GET
Old method used to transfer files. It works the same way as "rs/files/transferRev1". See that call for details

This method is deprecated. Use "/rs/files/transferRev1" instead
TransferRev1Resource
  • /rs/files/transferRev1
  • /rs/files/transferRev1/cancel
  • POST PUT
  • GET
Transfers a given set of files from a specified source to a specified destination. Files are transferred using the following method. First, obtain a connection key using either "/rs/agent/connect" or "rs/agent/register". Next, populate the request payload following the example below. Transfer using this call always use two connection keys. One is the key generated by the register or connect calls, the other is simply "local". To indicate an upload, the "local" key goes in the "SourceConnectionKey" field and the generated key goes in "DestinationConnectionKey" field. To indicate a download, the reverse is true. Finally, the "filelist" field must be populated. Files listed in the "filelist" field must be full paths. Remote files start with a backslash, local file are full paths to locations on local machines.
UserDetailsResource
  • /rs/agent/userDetails
  • GET POST
Retrieve or set data for a particular user. Currently, TransferAgent is only be able to set a user's email address and full name
UserPermissionsResource
  • /rs/agent/userPermissions
  • GET
Allows modification of a given user's permissions
VersionResource
  • /rs/agent/version
  • GET
Retrieves the version of the installed instance of TransferAgent
VirtualPathsResource
  • /rs/agent/virtualPaths
  • GET POST
Allows retrieval and modification of virtual paths within the TransferAgent. Virtual paths are used as a method for restricting local file listings within the TransferAgent. If virtual paths are defined with the application, the local file system listing will only contain files / directories that the current virtual file lists point to.
VisualImplResource
  • /rs/agent/visuals/client
  • GET
Retrieves the information necessary to populate diagrams. Similar to GraphImplResource, this resource delivers various transfer statistics used in some diagrams in FC products
WeblinkResource
  • /rs/agent/weblink
  • /rs/agent/weblink/cancel
  • /rs/agent/weblink/id
  • DELETE GET POST
  • GET
  • GET
Accesses, creates, and deletes weblinks within the TransferAgent. FC weblinks are URLs that can be distributed to arbitrary clients who can use them to download files to their local machines