Get a file tree
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>"
]
}
'import requests
url = "https://api.example.com/api/tree"
payload = {
"repoName": "<string>",
"revisionName": "<string>",
"paths": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({repoName: '<string>', revisionName: '<string>', paths: ['<string>']})
};
fetch('https://api.example.com/api/tree', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tree",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repoName' => '<string>',
'revisionName' => '<string>',
'paths' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tree"
payload := strings.NewReader("{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/tree")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tree")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"tree": {
"type": "<string>",
"path": "<string>",
"name": "<string>",
"children": "<array>"
}
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}Git
Get a file tree
Returns the file tree for a repository at a given revision.
POST
/
api
/
tree
Get a file tree
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>"
]
}
'import requests
url = "https://api.example.com/api/tree"
payload = {
"repoName": "<string>",
"revisionName": "<string>",
"paths": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({repoName: '<string>', revisionName: '<string>', paths: ['<string>']})
};
fetch('https://api.example.com/api/tree', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tree",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repoName' => '<string>',
'revisionName' => '<string>',
'paths' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tree"
payload := strings.NewReader("{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/tree")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tree")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repoName\": \"<string>\",\n \"revisionName\": \"<string>\",\n \"paths\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"tree": {
"type": "<string>",
"path": "<string>",
"name": "<string>",
"children": "<array>"
}
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"errorCode": "<string>",
"message": "<string>"
}Authorizations
bearerTokenapiKeyHeader
Bearer authentication header of the form Bearer <token>. The token may be a Sourcebot API key, OAuth access token, or scoped access token, subject to endpoint requirements.
Response
File tree for the requested repository revision.
Show child attributes
Show child attributes
Was this page helpful?
⌘I