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 the tutorial.

Request

edit

GET _connector/<connector_id>

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

<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:

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

« Delete connector API List connectors API »