curl --request POST \
--url https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://github.com/Qovery/simple-node-app",
"branch": "feat/text_xxx",
"root_path": "/",
"git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository"
payload = {
"url": "https://github.com/Qovery/simple-node-app",
"branch": "feat/text_xxx",
"root_path": "/",
"git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
url: 'https://github.com/Qovery/simple-node-app',
branch: 'feat/text_xxx',
root_path: '/',
git_token_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository', 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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository",
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([
'url' => 'https://github.com/Qovery/simple-node-app',
'branch' => 'feat/text_xxx',
'root_path' => '/',
'git_token_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository"
payload := strings.NewReader("{\n \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository")
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 \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
"infra",
"terraform",
".github"
]
}List directories from a git repository
List immediate subdirectories at a specified path in a git repository. This endpoint is used when creating Terraform services to help users browse and select the appropriate root path.
curl --request POST \
--url https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://github.com/Qovery/simple-node-app",
"branch": "feat/text_xxx",
"root_path": "/",
"git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository"
payload = {
"url": "https://github.com/Qovery/simple-node-app",
"branch": "feat/text_xxx",
"root_path": "/",
"git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
url: 'https://github.com/Qovery/simple-node-app',
branch: 'feat/text_xxx',
root_path: '/',
git_token_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository', 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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository",
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([
'url' => 'https://github.com/Qovery/simple-node-app',
'branch' => 'feat/text_xxx',
'root_path' => '/',
'git_token_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository"
payload := strings.NewReader("{\n \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/organization/{organizationId}/listDirectoriesFromGitRepository")
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 \"url\": \"https://github.com/Qovery/simple-node-app\",\n \"branch\": \"feat/text_xxx\",\n \"root_path\": \"/\",\n \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
"infra",
"terraform",
".github"
]
}Authorizations
JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Organization ID
Body
application git repository URL
"https://github.com/Qovery/simple-node-app"
BITBUCKET, GITHUB, GITLAB Name of the branch to use. This is optional
If not specified, then the branch used is the main or master one
"feat/text_xxx"
indicates the root path of the application.
The git token id on Qovery side
Response
List of directories at the specified path
["infra", "terraform", ".github"]
Was this page helpful?