create a vcs connection for Github
curl --request POST \
--url https://api.nuon.co/v1/vcs/connections \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"github_install_id": "<string>"
}
'import requests
url = "https://api.nuon.co/v1/vcs/connections"
payload = { "github_install_id": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({github_install_id: '<string>'})
};
fetch('https://api.nuon.co/v1/vcs/connections', 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.nuon.co/v1/vcs/connections",
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([
'github_install_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.nuon.co/v1/vcs/connections"
payload := strings.NewReader("{\n \"github_install_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.nuon.co/v1/vcs/connections")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"github_install_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuon.co/v1/vcs/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"github_install_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"created_by_id": "<string>",
"github_account_id": "<string>",
"github_account_name": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"queues": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"emitters": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"description": "<string>",
"emit_count": 123,
"fired": true,
"id": "<string>",
"jitter_window": 123,
"last_emitted_at": "<string>",
"name": "<string>",
"next_emit_at": "<string>",
"org_id": "<string>",
"queue_id": "<string>",
"scheduled_at": "<string>",
"signal_expires_in": 123,
"signal_template": {
"signal": "<unknown>"
},
"signal_type": "<string>",
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"id": "<string>",
"idle_timeout": 123,
"max_depth": 123,
"max_in_flight": 123,
"metadata": {},
"name": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"queue_signal": [
{
"callback": {
"namespace": "<string>",
"signal_name": "<string>",
"workflow_id": "<string>"
},
"callbacks": [
{
"namespace": "<string>",
"signal_name": "<string>",
"workflow_id": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"emitter_id": "<string>",
"enqueued": true,
"execution_count": 123,
"expires_at": "<string>",
"id": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"queue": "<unknown>",
"queue_id": "<string>",
"signal": {
"signal": "<unknown>"
},
"signal_context": {
"account_id": "<string>",
"log_stream_id": "<string>",
"org_id": "<string>",
"trace_id": "<string>"
},
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"type": "<string>",
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"status_v2": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"sha": "<string>",
"updated_at": "<string>",
"vcs_connection_id": "<string>"
}
]
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}create a vcs connection for Github
Create a VCS connection for version control integration.
POST
/
v1
/
vcs
/
connections
create a vcs connection for Github
curl --request POST \
--url https://api.nuon.co/v1/vcs/connections \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"github_install_id": "<string>"
}
'import requests
url = "https://api.nuon.co/v1/vcs/connections"
payload = { "github_install_id": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({github_install_id: '<string>'})
};
fetch('https://api.nuon.co/v1/vcs/connections', 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.nuon.co/v1/vcs/connections",
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([
'github_install_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.nuon.co/v1/vcs/connections"
payload := strings.NewReader("{\n \"github_install_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.nuon.co/v1/vcs/connections")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"github_install_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuon.co/v1/vcs/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"github_install_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"created_by_id": "<string>",
"github_account_id": "<string>",
"github_account_name": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"queues": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"emitters": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"description": "<string>",
"emit_count": 123,
"fired": true,
"id": "<string>",
"jitter_window": 123,
"last_emitted_at": "<string>",
"name": "<string>",
"next_emit_at": "<string>",
"org_id": "<string>",
"queue_id": "<string>",
"scheduled_at": "<string>",
"signal_expires_in": 123,
"signal_template": {
"signal": "<unknown>"
},
"signal_type": "<string>",
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"id": "<string>",
"idle_timeout": 123,
"max_depth": 123,
"max_in_flight": 123,
"metadata": {},
"name": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"queue_signal": [
{
"callback": {
"namespace": "<string>",
"signal_name": "<string>",
"workflow_id": "<string>"
},
"callbacks": [
{
"namespace": "<string>",
"signal_name": "<string>",
"workflow_id": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"emitter_id": "<string>",
"enqueued": true,
"execution_count": 123,
"expires_at": "<string>",
"id": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"queue": "<unknown>",
"queue_id": "<string>",
"signal": {
"signal": "<unknown>"
},
"signal_context": {
"account_id": "<string>",
"log_stream_id": "<string>",
"org_id": "<string>",
"trace_id": "<string>"
},
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"type": "<string>",
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"status_v2": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"workflow": {
"id": "<string>",
"namespace": "<string>",
"run_id": "<string>"
}
}
],
"status": {
"created_at_ts": 123,
"created_by_id": "<string>",
"history": "<array>",
"metadata": {},
"status_human_description": "<string>"
},
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"sha": "<string>",
"updated_at": "<string>",
"vcs_connection_id": "<string>"
}
]
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}{
"description": "<string>",
"error": "<string>",
"user_error": true
}Authorizations
APIKeyOrgID
Type "Bearer" followed by a space and token.
Body
application/json
Input
⌘I