Get all connectors

  • GET /_connector
Auth

Get information about all connectors.

Query parameters

from number · default: 0

Starting offset

size number · default: 100

Specifies a max number of results to get

index_name union string | string[]

A comma-separated list of connector index names to fetch connector documents for

connector_name union string | string[]

A comma-separated list of connector names to fetch connector documents for

service_type union string | string[]

A comma-separated list of connector service types to fetch connector documents for

query string

A wildcard query string that filters connectors with matching name, description or index name

Response

application/json
count number required
results object[] required
api_key_id string
api_key_secret_id string
configuration object required
custom_scheduling object required
description string
error union string nullable
One of: string
filtering object[] required
active object required
advanced_snippet object required
created_at union oneOf
One of: string or number
updated_at union oneOf
One of: string or number
value object required
rules object[] required
created_at union oneOf
One of: string or number
field string required
id string required
order number required
policy enum required
Values: exclude include
rule enum required
Values: contains ends_with equals regex starts_with > <
updated_at union oneOf
One of: string or number
value string required
validation object required
errors object[] required
ids string[] required
messages string[] required
state enum required
Values: edited invalid valid
domain string
draft object required
Same fields as active in filtering
id string
index_name union string nullable
is_native boolean required
language string
last_access_control_sync_error string
last_access_control_sync_scheduled_at union oneOf
One of: string or number
last_access_control_sync_status enum
Values: canceling canceled completed error in_progress pending suspended
last_deleted_document_count number
last_incremental_sync_scheduled_at union oneOf
One of: string or number
last_indexed_document_count number
last_seen union oneOf
One of: string or number
last_sync_error string
last_sync_scheduled_at union oneOf
One of: string or number
last_sync_status enum
Values: canceling canceled completed error in_progress pending suspended
last_synced union oneOf
One of: string or number
name string
scheduling object required
service_type string
status enum required
Values: created needs_configuration configured connected error
sync_cursor object
sync_now boolean required