Get a file tree

Returns the file tree for a repository at a given revision.

POST /api/tree

Get a file tree

cURL

curl --request POST \
  --url https://api.example.com/api/tree \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repoName": "<string>",
  "revisionName": "<string>",
  "paths": [
    "<string>"
  ]
}
'

200

{
  "tree": {
    "type": "<string>",
    "path": "<string>",
    "name": "<string>",
    "children": "<array>"
  }
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body

application/json

repoName · string · required

revisionName · string · required

paths · string[] · required

Response

200

application/json

File tree for the requested repository revision.

tree · object · required

Show child attributes