An open-source scalable personal cloud

Resource overview

Here are the types of resources available through the API:


A user resource represents information about a StackSync user.

  • user_id. The user’s unique identifier in StackSync.
  • username The user’s nickname in the system.
  • email. The user’s email.
  • quota_limit. The user’s available quota (in bytes).
  • quota_usage. The user’s used quota (in bytes).


A Metadata resource represents the information of a specific file or folder. It will
contain the following fields:

  • is_folder. Indicates whether the given entry is a folder or not.
  • is_root. Indicates whether the given entry is the root folder or not.
  • status. Possible values are NEW , CHANGED, DELETED. Indicating the status of the file in this specific version.
  • path. The canonical path to the file or directory.
  • size. The file size in bytes (only for files).
  • mimetype. The media type of the file (only for files).
  • checksum. The file’s checksum.
  • version. A unique identifier for the current version of a file. Can be used to detect changes and avoid conflicts.
  • filename. The name of the file or folder.
  • user. The name of the user that made modified this specific version.
  • file_id. A unique identifier for a file or folder.
  • client_modified. This is the modification time set by the desktop client when the file was last modified, in the standard date format. Since this time is not verified (the server stores whatever the desktop client ends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
  • server_modified. This is the modification time set by the server at the time of processing the file.


A Content resource represents the data in a specific file, that is, the actual bytes in the file.