IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get connector sync job API List connector sync jobs API »

› › ›

List connectors API

edit

List connectors API

edit

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 stored connectors.

Request

edit

GET _connector

Prerequisites

edit

To sync data using connectors, it’s essential to have the Elastic connectors service running.

Path parameters

edit

size: (Optional, integer) Maximum number of results to retrieve.
from: (Optional, integer) The offset from the first result to fetch.
index_name: (Optional, string) A comma-separated list of data 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.

Examples

edit

The following example lists all connectors:

response = client.connector.list
puts response

GET _connector

The following example lists the first two connectors:

response = client.connector.list(
  from: 0,
  size: 2
)
puts response

GET _connector/?from=0&size=2

An example to list connectors associated with search-google-drive data index name:

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

« Get connector sync job API List connector sync jobs API »