Sign in

v1

latestOpenAPI 3.0.32026-07-22115106141.4 KB
Repository Manipulation

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

get/repos/{repo_id}/trees/{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

recurseboolean

Specifies if to recursively iterate file tree to next directory levels

skipinteger
Example:17

Skip a number of items returned from a listing api

limitinteger
Example:17

Limit the number of entries returned from walk

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

workspace_journal_ordinal_idinteger

An ordinal ID of a workspace journal entry

The ordinal ID of the journal entry the walk references, if applicable

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

Response

Success

object'FileEntry' required
workspace_journal_ordinal_idinteger

An ordinal ID of a workspace journal entry

Example response

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