Test a code repository connection
curl --request POST \
--url http://localhost:8080/api/v1/code-repo/test \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"provider": "<string>",
"repo": "<string>",
"apiBaseUrl": "<string>",
"branch": "<string>",
"pathPrefix": "<string>",
"authSecretName": "<string>",
"commitAuthor": "<string>",
"commitMessageTemplate": "<string>",
"enabled": true
}
'import requests
url = "http://localhost:8080/api/v1/code-repo/test"
payload = {
"name": "<string>",
"provider": "<string>",
"repo": "<string>",
"apiBaseUrl": "<string>",
"branch": "<string>",
"pathPrefix": "<string>",
"authSecretName": "<string>",
"commitAuthor": "<string>",
"commitMessageTemplate": "<string>",
"enabled": 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({
name: '<string>',
provider: '<string>',
repo: '<string>',
apiBaseUrl: '<string>',
branch: '<string>',
pathPrefix: '<string>',
authSecretName: '<string>',
commitAuthor: '<string>',
commitMessageTemplate: '<string>',
enabled: true
})
};
fetch('http://localhost:8080/api/v1/code-repo/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/code-repo/test",
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([
'name' => '<string>',
'provider' => '<string>',
'repo' => '<string>',
'apiBaseUrl' => '<string>',
'branch' => '<string>',
'pathPrefix' => '<string>',
'authSecretName' => '<string>',
'commitAuthor' => '<string>',
'commitMessageTemplate' => '<string>',
'enabled' => 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 := "http://localhost:8080/api/v1/code-repo/test"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": 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("http://localhost:8080/api/v1/code-repo/test")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/code-repo/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"canPush": true,
"branchExists": true,
"defaultBranch": "<string>",
"branches": [
"<string>"
],
"error": "<string>"
}Code repository
Test a code repository connection
Round-trip check for the posted configuration — repository reachable, token has push access, branch exists. Always returns 200 with an ok flag.
POST
/
api
/
v1
/
code-repo
/
test
Test a code repository connection
curl --request POST \
--url http://localhost:8080/api/v1/code-repo/test \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"provider": "<string>",
"repo": "<string>",
"apiBaseUrl": "<string>",
"branch": "<string>",
"pathPrefix": "<string>",
"authSecretName": "<string>",
"commitAuthor": "<string>",
"commitMessageTemplate": "<string>",
"enabled": true
}
'import requests
url = "http://localhost:8080/api/v1/code-repo/test"
payload = {
"name": "<string>",
"provider": "<string>",
"repo": "<string>",
"apiBaseUrl": "<string>",
"branch": "<string>",
"pathPrefix": "<string>",
"authSecretName": "<string>",
"commitAuthor": "<string>",
"commitMessageTemplate": "<string>",
"enabled": 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({
name: '<string>',
provider: '<string>',
repo: '<string>',
apiBaseUrl: '<string>',
branch: '<string>',
pathPrefix: '<string>',
authSecretName: '<string>',
commitAuthor: '<string>',
commitMessageTemplate: '<string>',
enabled: true
})
};
fetch('http://localhost:8080/api/v1/code-repo/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/code-repo/test",
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([
'name' => '<string>',
'provider' => '<string>',
'repo' => '<string>',
'apiBaseUrl' => '<string>',
'branch' => '<string>',
'pathPrefix' => '<string>',
'authSecretName' => '<string>',
'commitAuthor' => '<string>',
'commitMessageTemplate' => '<string>',
'enabled' => 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 := "http://localhost:8080/api/v1/code-repo/test"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": 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("http://localhost:8080/api/v1/code-repo/test")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/code-repo/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"repo\": \"<string>\",\n \"apiBaseUrl\": \"<string>\",\n \"branch\": \"<string>\",\n \"pathPrefix\": \"<string>\",\n \"authSecretName\": \"<string>\",\n \"commitAuthor\": \"<string>\",\n \"commitMessageTemplate\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"canPush": true,
"branchExists": true,
"defaultBranch": "<string>",
"branches": [
"<string>"
],
"error": "<string>"
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Body
application/json
Always default — one repository per tenant
Repository provider (github)
Repository in owner/repo form
API endpoint; override for GitHub Enterprise Server (e.g. https://ghes.example.com/api/v3)
Script path becomes {pathPrefix}{tapName}.py
Vault secret (tagged _type=repo_token) holding a token field. The token itself is never returned by the API.
Commit author in Name <email> form
Commit message template. Tokens: {name}, {action}, {user}
⌘I
