Analyze a GitHub repository
curl --request POST \
--url https://bulkgrid.com/api/v1/index/sources/github/analyze \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"repositoryUrl": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"suggestPaths": true
}
'import requests
url = "https://bulkgrid.com/api/v1/index/sources/github/analyze"
payload = {
"repositoryUrl": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"suggestPaths": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repositoryUrl: '<string>',
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ref: '<string>',
suggestPaths: true
})
};
fetch('https://bulkgrid.com/api/v1/index/sources/github/analyze', 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://bulkgrid.com/api/v1/index/sources/github/analyze",
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([
'repositoryUrl' => '<string>',
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ref' => '<string>',
'suggestPaths' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://bulkgrid.com/api/v1/index/sources/github/analyze"
payload := strings.NewReader("{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://bulkgrid.com/api/v1/index/sources/github/analyze")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/index/sources/github/analyze")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}"
response = http.request(request)
puts response.read_body{
"label": "<string>",
"ref": "<string>",
"includePaths": [
"<string>"
],
"excludePaths": [
"<string>"
],
"confidence": 0.5,
"notes": "<string>",
"fileCount": 4503599627370495,
"defaultBranch": "<string>",
"latestRelease": {
"status": "available",
"tag": "<string>"
},
"files": [
"<string>"
]
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Sources
Analyze a GitHub repository
Required permission: sources:write.
POST
/
api
/
v1
/
index
/
sources
/
github
/
analyze
Analyze a GitHub repository
curl --request POST \
--url https://bulkgrid.com/api/v1/index/sources/github/analyze \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"repositoryUrl": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"suggestPaths": true
}
'import requests
url = "https://bulkgrid.com/api/v1/index/sources/github/analyze"
payload = {
"repositoryUrl": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"suggestPaths": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repositoryUrl: '<string>',
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ref: '<string>',
suggestPaths: true
})
};
fetch('https://bulkgrid.com/api/v1/index/sources/github/analyze', 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://bulkgrid.com/api/v1/index/sources/github/analyze",
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([
'repositoryUrl' => '<string>',
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ref' => '<string>',
'suggestPaths' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://bulkgrid.com/api/v1/index/sources/github/analyze"
payload := strings.NewReader("{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://bulkgrid.com/api/v1/index/sources/github/analyze")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/index/sources/github/analyze")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repositoryUrl\": \"<string>\",\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref\": \"<string>\",\n \"suggestPaths\": true\n}"
response = http.request(request)
puts response.read_body{
"label": "<string>",
"ref": "<string>",
"includePaths": [
"<string>"
],
"excludePaths": [
"<string>"
],
"confidence": 0.5,
"notes": "<string>",
"fileCount": 4503599627370495,
"defaultBranch": "<string>",
"latestRelease": {
"status": "available",
"tag": "<string>"
},
"files": [
"<string>"
]
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Authorizations
apiKeyAuthbearerAuth
Bulkgrid API key
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 255Response
Successful response
Required string length:
1 - 200Required string length:
1 - 255Maximum array length:
100Required string length:
1 - 1024Maximum array length:
100Required string length:
1 - 1024Required range:
0 <= x <= 1Required string length:
1 - 1000Required range:
0 <= x <= 9007199254740991Minimum string length:
1- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Minimum string length:
1