Skip to main content
POST
/
manage
/
admin
/
connector
Create Connector From Model
curl --request POST \
  --url https://cloud.onyx.app/api/manage/admin/connector \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "connector_specific_config": {},
  "refresh_freq": 123,
  "prune_freq": 123,
  "indexing_start": "2023-11-07T05:31:56Z",
  "groups": [
    123
  ]
}
'
import requests

url = "https://cloud.onyx.app/api/manage/admin/connector"

payload = {
"name": "<string>",
"connector_specific_config": {},
"refresh_freq": 123,
"prune_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z",
"groups": [123]
}
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({
name: '<string>',
connector_specific_config: {},
refresh_freq: 123,
prune_freq: 123,
indexing_start: '2023-11-07T05:31:56Z',
groups: [123]
})
};

fetch('https://cloud.onyx.app/api/manage/admin/connector', 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://cloud.onyx.app/api/manage/admin/connector",
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>',
'connector_specific_config' => [

],
'refresh_freq' => 123,
'prune_freq' => 123,
'indexing_start' => '2023-11-07T05:31:56Z',
'groups' => [
123
]
]),
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://cloud.onyx.app/api/manage/admin/connector"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"connector_specific_config\": {},\n \"refresh_freq\": 123,\n \"prune_freq\": 123,\n \"indexing_start\": \"2023-11-07T05:31:56Z\",\n \"groups\": [\n 123\n ]\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://cloud.onyx.app/api/manage/admin/connector")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"connector_specific_config\": {},\n \"refresh_freq\": 123,\n \"prune_freq\": 123,\n \"indexing_start\": \"2023-11-07T05:31:56Z\",\n \"groups\": [\n 123\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/manage/admin/connector")

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 \"name\": \"<string>\",\n \"connector_specific_config\": {},\n \"refresh_freq\": 123,\n \"prune_freq\": 123,\n \"indexing_start\": \"2023-11-07T05:31:56Z\",\n \"groups\": [\n 123\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "credential": {
    "credential_json": {},
    "admin_public": true,
    "id": 123,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "time_created": "2023-11-07T05:31:56Z",
    "time_updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "curator_public": false,
    "groups": [
      123
    ],
    "user_email": "<string>"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
name
string
required
source
enum<string>
required
Available options:
ingestion_api,
slack,
web,
google_drive,
gmail,
requesttracker,
github,
gitbook,
gitlab,
guru,
bookstack,
outline,
confluence,
jira,
slab,
productboard,
file,
coda,
notion,
zulip,
linear,
hubspot,
document360,
gong,
google_sites,
zendesk,
loopio,
dropbox,
sharepoint,
teams,
salesforce,
discourse,
axero,
clickup,
mediawiki,
wikipedia,
asana,
s3,
r2,
google_cloud_storage,
oci_storage,
xenforo,
not_applicable,
discord,
freshdesk,
fireflies,
egnyte,
airtable,
highspot,
drupal_wiki,
imap,
bitbucket,
testrail,
mock_connector,
user_file
input_type
enum<string>
required
Available options:
load_state,
poll,
event,
slim_retrieval
connector_specific_config
Connector Specific Config · object
required
access_type
enum<string>
required
Available options:
public,
private,
sync
refresh_freq
integer | null
prune_freq
integer | null
indexing_start
string<date-time> | null
groups
integer[]

Response

Successful Response

id
integer
required
credential
CredentialSnapshot · object | null