You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
List connectors APIedit
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Returns information about all created connectors.
Requestedit
GET _connector
Prerequisitesedit
- To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
Path parametersedit
-
size -
(Optional, integer) Maximum number of results to retrieve. Defaults to
100. -
from -
(Optional, integer) The offset from the first result to fetch. Defaults to
0. -
index_name - (Optional, string) A comma-separated list of index names associated with connectors, used to filter search results.
-
connector_name - (Optional, string) A comma-separated list of connector names, used to filter search results.
-
service_type - (Optional, string) A comma-separated list of connector service types, used to filter search results.
Examplesedit
The following example lists all connectors:
response = client.connector.list puts response
GET _connector
The following example lists the first two connectors:
GET _connector?from=0&size=2
An example to list a connector associated with the search-google-drive Elasticsearch index:
GET _connector?index_name=search-google-drive
An example to list all connectors with sharepoint_online service type:
GET _connector?service_type=sharepoint_online
An example to list all connectors with sharepoint_online or google_drive service type:
GET _connector?service_type=sharepoint_online,google_drive