› › ›

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

Retrieves the details about a connector.

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

Request

GET _connector/<connector_id>

Prerequisites

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 Elastic managed connectors.

Path parameters

<connector_id>: (Required, string)

Response codes

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

Examples

The following example gets the connector my-connector:

resp = client.connector.get(
    connector_id="my-connector",
)
print(resp)

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

const response = await client.connector.get({
  connector_id: "my-connector",
});
console.log(response);

GET _connector/my-connector

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html