Get a connector
- GET /_connector/{connector_id}
Get the details about a connector.
Path Parameters
-
connector_idstring Idrequired -
The unique identifier of the connector
Query Parameters
-
include_deletedboolean · default: false A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
Response
application/json
-
api_key_idstring -
api_key_secret_idstring -
configurationConnectorConfigurationrequired -
custom_schedulingConnectorCustomSchedulingrequired -
deletedbooleanrequired -
descriptionstring -
errorstringnullable -
featuresConnectorFeatures -
document_level_securityFeatureEnabled -
Indicates whether document-level security is enabled.
-
enabledbooleanrequired -
incremental_syncFeatureEnabled -
Indicates whether incremental syncs are enabled.
-
enabledbooleanrequired -
native_connector_api_keysFeatureEnabled -
Indicates whether managed connector API keys are enabled.
-
enabledbooleanrequired -
sync_rulesSyncRulesFeature -
filteringFilteringConfigrequired -
activeFilteringRulesrequired -
advanced_snippetFilteringAdvancedSnippetrequired -
created_atDateTime -
updated_atDateTime -
valueobjectrequired -
rulesFilteringRulerequired -
created_atDateTime -
fieldstring Fieldrequired -
idstring Idrequired -
ordernumberrequired -
policyFilteringPolicyrequired -
Values:
excludeinclude -
ruleFilteringRuleRulerequired -
Values:
containsends_withequalsregexstarts_with>< -
updated_atDateTime -
valuestringrequired -
validationFilteringRulesValidationrequired -
domainstring -
draftFilteringRulesrequired -
idstring Id -
index_nameIndexName | stringnullable -
is_nativebooleanrequired -
languagestring -
last_access_control_sync_statusSyncStatus -
Values:
cancelingcanceledcompletederrorin_progresspendingsuspended -
last_deleted_document_countnumber -
last_incremental_sync_scheduled_atDateTime -
last_indexed_document_countnumber -
last_seenDateTime -
last_sync_errorstring -
last_sync_scheduled_atDateTime -
last_sync_statusSyncStatus -
Values:
cancelingcanceledcompletederrorin_progresspendingsuspended -
last_syncedDateTime -
namestring -
pipelineIngestPipelineParams -
extract_binary_contentbooleanrequired -
namestringrequired -
reduce_whitespacebooleanrequired -
run_ml_inferencebooleanrequired -
schedulingSchedulingConfigurationrequired -
access_controlConnectorScheduling -
fullConnectorScheduling -
incrementalConnectorScheduling -
service_typestring -
statusConnectorStatusrequired -
Values:
createdneeds_configurationconfiguredconnectederror -
sync_cursorobject -
sync_nowbooleanrequired