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>",
  "source": "ingestion_api",
  "input_type": "load_state",
  "connector_specific_config": {},
  "refresh_freq": 123,
  "prune_freq": 123,
  "indexing_start": "2023-11-07T05:31:56Z",
  "access_type": "public",
  "groups": [
    123
  ]
}'
{
  "id": 123,
  "credential": {
    "credential_json": {},
    "admin_public": true,
    "source": "ingestion_api",
    "name": "<string>",
    "curator_public": false,
    "groups": [
      123
    ],
    "is_user_file": false,
    "id": 123,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_email": "<string>",
    "time_created": "2023-11-07T05:31:56Z",
    "time_updated": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth 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,
confluence,
jira,
slab,
productboard,
file,
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,
imap,
mock_connector
input_type
enum<string>
required
Available options:
load_state,
poll,
event,
slim_retrieval
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
credential
object | null
I