Search and browse capabilities across backup data. The primary mechanism for locating files, emails, and other items within Keepit backups.
Does not filter by default — all entries are returned including deleted and system files.
Search backup
Searches and browses backed-up data across one or more devices. At least
pathRoot or searchTerms must be specified.
Search terms are space-separated and matched with fuzzy logic. Use quotes for
exact phrase matching (e.g. "quarterly report").
The search does not filter results by default. Use filterAnd or filterOr
query parameters to narrow results. Filter expressions use Polish notation.
When specifying pathRoot, paths use masking: : becomes -c, / becomes
-s, and - becomes --.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
query Parameters
pathRootFull masked path to the container of files to search. At least pathRoot or searchTerms must be specified.
deviceDevice GUID. Required when pathRoot is specified.
recursiveEnable recursive search in pathRoot and its subfolders. Default 0.
countMaximum number of results in response. Default 100.
startIndexIndex of first result. Default 0.
snaptimeDisregard information that appeared after this ISO8601 timestamp.
snaptimeFromDefine snapshot range start (ISO8601 timestamp).
snaptimeToDefine snapshot range end (ISO8601 timestamp).
includeBodyReturn full response. Set to 0 to get only the count of matching items. Default 1.
fullHistoryReturn all versions of a single file. Use with device, pathRoot, and itemName. Default 0.
explainQueryInclude queryDetails element with extracted searchTerms in response. Default 0.
resolveIdsAlso return human-readable path for each id tag. Default 0.
searchTermsSpace-separated list of terms to search for. At least searchTerms or pathRoot must be specified.
itemNameExact name of the item to search for. Use for history queries, not classical search.
sortTermsComma-separated list of sort terms (title, name, updated, time, error, audio, video, image, message, document, folder, size). Prefix with "-" to reverse.
filterAndFilter expression with AND logic between groups. Cannot be used together with filterOr.
filterOrFilter expression with OR logic between groups. Cannot be used together with filterAnd.
apiVersionAPI version to use. Default 1.
Search backup › Responses
success
Get search categories
Returns available content categories for the specified device. Categories classify backed-up items by type (e.g. documents, images, messages).
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
query Parameters
deviceDevice GUID to search.
statisticsProvide category statistics. Should be used with recursive set to 0.
recursiveRun recursively down the files tree.
Get search categories › Responses
success
Resolve path
Resolves a backup path to its human-readable form. The path parameter accepts
both masked path format and plain paths.
Paths use escape masking where : is written as -c, / as -s, and - as --.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
query Parameters
deviceDevice GUID to search.
pathPath to resolve. Supported in single-item queries only.
snaptimeToDefine snapshot range end (ISO8601 timestamp).
Resolve path › Responses
Update resolved path
Resolves multiple backup paths in a single batch request. Submit a list of path entries in the request body and receive resolved human-readable paths in the response.
Path masking rules apply: : → -c, / → -s, - → --.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).