Create connector target
curl --request POST \
--url https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets \
--header 'Content-Type: application/json' \
--data '
{
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"config": {},
"externalTargetRef": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets"
payload = {
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"config": {},
"externalTargetRef": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
connectorType: 'github',
remoteId: '<string>',
targetKind: 'repository_branch',
config: {},
externalTargetRef: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets', 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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets",
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([
'connectorType' => 'github',
'remoteId' => '<string>',
'targetKind' => 'repository_branch',
'config' => [
],
'externalTargetRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets"
payload := strings.NewReader("{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets")
.header("Content-Type", "application/json")
.body("{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"id": "<string>",
"connectorInstanceId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"externalTargetRef": "<string>",
"targetConfigJson": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Connectors
Create connector target
Creates a connector target under a connector instance.
POST
/
v1
/
connector-instances
/
{connectorInstanceId}
/
targets
Create connector target
curl --request POST \
--url https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets \
--header 'Content-Type: application/json' \
--data '
{
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"config": {},
"externalTargetRef": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets"
payload = {
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"config": {},
"externalTargetRef": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
connectorType: 'github',
remoteId: '<string>',
targetKind: 'repository_branch',
config: {},
externalTargetRef: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets', 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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets",
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([
'connectorType' => 'github',
'remoteId' => '<string>',
'targetKind' => 'repository_branch',
'config' => [
],
'externalTargetRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets"
payload := strings.NewReader("{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets")
.header("Content-Type", "application/json")
.body("{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectorType\": \"github\",\n \"remoteId\": \"<string>\",\n \"targetKind\": \"repository_branch\",\n \"config\": {},\n \"externalTargetRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"id": "<string>",
"connectorInstanceId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"externalTargetRef": "<string>",
"targetConfigJson": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Path Parameters
Den TypeID with 'cin_' prefix and a 26-character base32 suffix.
Required string length:
30Pattern:
^cin_.*Body
application/json
Was this page helpful?
⌘I