Get connector 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.

Retrieves the details about a connector.

Request

edit

GET _connector/<connector_id>

Prerequisites

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

Path parameters

edit
<connector_id>
(Required, string)

Response codes

edit
400
The connector_id was not provided.
404 (Missing resources)
No connector matching connector_id could be found.

Examples

edit

The following example gets the connector my-connector:

response = client.connector.get(
  connector_id: 'my-connector'
)
puts response
GET _connector/my-connector