Endpoints for sharing backup files or folder hierarchies with the public. Shares generate links that either trigger immediate file downloads or present a browsable web UI for directories.
Create share
Creates a new share link for one or more backed-up items. Share links provide external access to backup data via a unique URL.
Shares can be configured with an expiry date, password protection, and access count limits. The account's share policy determines which settings are permitted.
Create share › Responses
success
Browse share
Not documented yet — wildcard endpoint.
/share/{shareId}/root/{wildcard} collapses a whole subtree of distinct URIs
into a single {wildcard} entry. It must be expanded into its individual
endpoints in endpoints.yaml before it can be documented. The response schema
and description have been intentionally removed until that happens.
path Parameters
shareIdwildcardquery Parameters
countNumber of entries in response. Default 100.
startIndexIndex of first entry to show. Default 0.
sortTermsComma-separated list of sort terms.
Browse share › Responses
success
Download from share
Initiates a download of one or more items from a share. The request body specifies which items to download and the desired format (raw, email preview, or document preview).
The response contains a download configuration with token-based URLs that can be used to retrieve the files without additional authentication.
path Parameters
shareIdDownload from share › Responses
Get share policy
Returns the sharing policy for the specified account. The policy defines constraints for share links, including whether sharing is allowed, maximum expiry duration, and password requirements.
Check the share policy before creating shares to ensure the intended share configuration is permitted by the account policy.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get share policy › Responses
success
Download item
Downloads a file using a token-based download URL. This endpoint does not require authentication — the alias in the URL serves as the access token.
The response returns the raw file content with the appropriate Content-Type header.
path Parameters
itemAliasitemNameDownload item › Responses
success