Get Connector Indexing Status
curl --request POST \
--url https://cloud.onyx.app/api/manage/admin/connector/indexing-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secondary_index": false,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": false
}
'[
{
"summary": {
"total_connectors": 123,
"active_connectors": 123,
"public_connectors": 123,
"total_docs_indexed": 123
},
"current_page": 123,
"total_pages": 123,
"indexing_statuses": [
{
"cc_pair_id": 123,
"name": "<string>",
"in_progress": true,
"in_repeated_error_state": true,
"last_success": "2023-11-07T05:31:56Z",
"is_editable": true,
"docs_indexed": 123,
"latest_index_attempt_docs_indexed": 123
}
]
}
]Connectors
Get Connector Indexing Status
POST
/
manage
/
admin
/
connector
/
indexing-status
Get Connector Indexing Status
curl --request POST \
--url https://cloud.onyx.app/api/manage/admin/connector/indexing-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secondary_index": false,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": false
}
'[
{
"summary": {
"total_connectors": 123,
"active_connectors": 123,
"public_connectors": 123,
"total_docs_indexed": 123
},
"current_page": 123,
"total_pages": 123,
"indexing_statuses": [
{
"cc_pair_id": 123,
"name": "<string>",
"in_progress": true,
"in_repeated_error_state": true,
"last_success": "2023-11-07T05:31:56Z",
"is_editable": true,
"docs_indexed": 123,
"latest_index_attempt_docs_indexed": 123
}
]
}
]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 header with Bearer token
Body
application/json
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 Available options:
public, private, sync Available options:
not_started, in_progress, success, canceled, failed, completed_with_errors Available options:
>, <, = Show child attributes
Show child attributes
Response
Successful Response
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 Show child attributes
Show child attributes
indexing_statuses
(ConnectorIndexingStatusLite · object | FederatedConnectorStatus · object)[]
required
- ConnectorIndexingStatusLite
- FederatedConnectorStatus
Show child attributes
Show child attributes
Was this page helpful?
⌘I