IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Elasticsearch Guide [8.12] ›REST APIs ›Connector APIs
« Get connector sync job API List connector sync jobs API »

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

Requestedit

GET _connector

Prerequisitesedit

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

Path parametersedit

size
(Optional, integer) Maximum number of results to retrieve.
from
(Optional, integer) The offset from the first result to fetch.

Examplesedit

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
« Get connector sync job API List connector sync jobs API »