Connect a deployment to a GitHub repository and trigger a build
curl --request POST \
--url https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"installationId": 123,
"name": "<string>",
"deployBranchName": "<string>",
"deployProjectRoot": "<string>",
"isNewRepo": true,
"private": true
}
'import requests
url = "https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect"
payload = {
"installationId": 123,
"name": "<string>",
"deployBranchName": "<string>",
"deployProjectRoot": "<string>",
"isNewRepo": True,
"private": True
}
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({
installationId: 123,
name: '<string>',
deployBranchName: '<string>',
deployProjectRoot: '<string>',
isNewRepo: true,
private: true
})
};
fetch('https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect', 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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect",
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([
'installationId' => 123,
'name' => '<string>',
'deployBranchName' => '<string>',
'deployProjectRoot' => '<string>',
'isNewRepo' => true,
'private' => true
]),
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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect"
payload := strings.NewReader("{\n \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect")
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 \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\n}"
response = http.request(request)
puts response.read_body{
"deploymentUrl": "<string>",
"id": 123,
"name": "<string>"
}GitHub Connection
Connect a deployment to a GitHub repository and trigger a build
POST
/
build
/
api
/
v1
/
deployments
/
{deploymentId}
/
github
/
connect
Connect a deployment to a GitHub repository and trigger a build
curl --request POST \
--url https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"installationId": 123,
"name": "<string>",
"deployBranchName": "<string>",
"deployProjectRoot": "<string>",
"isNewRepo": true,
"private": true
}
'import requests
url = "https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect"
payload = {
"installationId": 123,
"name": "<string>",
"deployBranchName": "<string>",
"deployProjectRoot": "<string>",
"isNewRepo": True,
"private": True
}
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({
installationId: 123,
name: '<string>',
deployBranchName: '<string>',
deployProjectRoot: '<string>',
isNewRepo: true,
private: true
})
};
fetch('https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect', 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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect",
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([
'installationId' => 123,
'name' => '<string>',
'deployBranchName' => '<string>',
'deployProjectRoot' => '<string>',
'isNewRepo' => true,
'private' => true
]),
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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect"
payload := strings.NewReader("{\n \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\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://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/build/api/v1/deployments/{deploymentId}/github/connect")
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 \"installationId\": 123,\n \"name\": \"<string>\",\n \"deployBranchName\": \"<string>\",\n \"deployProjectRoot\": \"<string>\",\n \"isNewRepo\": true,\n \"private\": true\n}"
response = http.request(request)
puts response.read_body{
"deploymentUrl": "<string>",
"id": 123,
"name": "<string>"
}Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Body
application/json
ConnectGitHubRequest
⌘I