Sign in

v1

latestOpenAPI 3.0.32026-07-22115106141.4 KB
Repository Manipulation

Get tree content stream

Get file tree snapshot. Either one of workspace, branch or commit ID needs to be specified as ref ID

get/repos/{repo_id}/tree_content/{ref_id}

Path parameters

repo_idstring required
Example:example_id

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

ref_idstring required
Example:example_id

An ID of a workspace, branch or commit.

Query parameters

pathstring path
Example:/path/to/file

Optional path to an item inside the repository.

recurseboolean

Specifies if to recursively iterate file tree to next directory levels

offsetstring
Example:file.ext

Offset item name in directory when iterating its entries (non-inclusive)

include_deletedboolean

Should the tree contain also deleted items or omit them from response

item_name_querystring
Example:abcd

A query string to test against item name, only matching items will be collected

dirs_onlyboolean

Return only directories in the file tree walk

use_selective_syncboolean

Return the results filtered by the workspace preferences for selective sync

max_depthinteger
include_download_urlsboolean

Specifies whether to include temporary download URLs in the response or not, defaults to false.

Response

Stream of file tree entries

pathstring required
prev_pathstring

Optional hint in case the item was renamed or moved

status1 | 2 | 3 | 4 required

One of: 1 - INTACT, 2 - ADDED, 3 - MODIFIED, 4 - DELETED

mode16877 | 33188 | 33261 | 40960 required

The file mode (as Unix mode)

mtimestring date-time

Example response

[
  {
    "path": "hello.cc",
    "blob": {
      "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
    }
  }
]