Skip to main content
GET
/
manage
/
connector
/
{connector_id}
Get Connector By Id
curl --request GET \
  --url https://cloud.onyx.app/api/manage/connector/{connector_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "connector_specific_config": {},
  "id": 123,
  "credential_ids": [
    123
  ],
  "time_created": "2023-11-07T05:31:56Z",
  "time_updated": "2023-11-07T05:31:56Z",
  "refresh_freq": 123,
  "prune_freq": 123,
  "indexing_start": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onyx.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

​
connector_id
integer
required

Response

Successful Response

​
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
​
id
integer
required
​
credential_ids
integer[]
required
​
time_created
string<date-time>
required
​
time_updated
string<date-time>
required
​
refresh_freq
integer | null
​
prune_freq
integer | null
​
indexing_start
string<date-time> | null