List connectors API

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Returns information about all created connectors.

To get started with Connector APIs, check out the tutorial.

Request

edit

GET _connector

Prerequisites

edit

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 parameters

edit

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.

Examples

edit

The following example lists all connectors:

resp = client.connector.list()
print(resp)

response = client.connector.list
puts response

const response = await client.connector.list();
console.log(response);

GET _connector

The following example lists the first two connectors:

resp = client.connector.list(
    from_="0",
    size="2",
)
print(resp)

const response = await client.connector.list({
  from: 0,
  size: 2,
});
console.log(response);

GET _connector?from=0&size=2

An example to list a connector associated with the search-google-drive Elasticsearch index:

resp = client.connector.list(
    index_name="search-google-drive",
)
print(resp)

const response = await client.connector.list({
  index_name: "search-google-drive",
});
console.log(response);

GET _connector?index_name=search-google-drive

An example to list all connectors with sharepoint_online service type:

resp = client.connector.list(
    service_type="sharepoint_online",
)
print(resp)

const response = await client.connector.list({
  service_type: "sharepoint_online",
});
console.log(response);

GET _connector?service_type=sharepoint_online

An example to list all connectors with sharepoint_online or google_drive service type:

resp = client.connector.list(
    service_type="sharepoint_online,google_drive",
)
print(resp)

const response = await client.connector.list({
  service_type: "sharepoint_online,google_drive",
});
console.log(response);

GET _connector?service_type=sharepoint_online,google_drive

« Get connector API Update connector API key ID API »