Skip to main content
Skip table of contents

API documentation

You can find the documentation for FileSender’s API at

https://docs.filesender.org/filesender/v3.0/rest/ .

Please note that this is an external website; not administered by REANNZ.

The FileSender API scripts linked above are capable of performing the following actions for authenticated users:

  • Get a list of all of the user’s transfers.

  • Get information about a specific transfer.

  • Get the options of a specific transfer.

  • Get the audit logs of a specific transfer.

  • Create a new transfer.

  • Add a new recipient to an existing transfer.

  • Update a specific transfer.

  • Close a specific transfer.

  • Get information about a specific file.

  • Update a file’s body.

  • Add a chunk to a file’s body at a given offset.

  • Update a file.

  • Delete a file.

  • Get information about a specific transfer recipient.

  • Update a recipient.

  • Delete a recipient from a transfer.

  • List all guests associated with a user.

  • Get information about a specific guest.

  • Create a new guest from a request.

  • Update a guest.

  • Delete a guest.

  • Get the preferences of a user.

  • Get a list of frequent recipients of the current user.

  • Get a list of frequent recipients of a specific user.

  • Set a user’s preferences.

  • Get information about the FileSender instance.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.