elasticsearch/docs/reference/connector/apis/get-connector-api.asciidoc

[[get-connector-api]]
=== Get connector API
++++
<titleabbrev>Get connector</titleabbrev>
++++

preview::[]

Retrieves the details about a connector.

[[get-connector-api-request]]
==== {api-request-title}

`GET _connector/<connector_id>`

[[get-connector-api-prereq]]
==== {api-prereq-title}

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

[[get-connector-api-path-params]]
==== {api-path-parms-title}

`<connector_id>`::
(Required, string)

[[get-connector-api-response-codes]]
==== {api-response-codes-title}

`400`::
The `connector_id` was not provided.

`404` (Missing resources)::
No connector matching `connector_id` could be found.

[[get-connector-api-example]]
==== {api-examples-title}

The following example gets the connector `my-connector`:

////
[source,console]
--------------------------------------------------
PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "Google Drive Connector",
  "service_type": "google_drive"
}

--------------------------------------------------
// TESTSETUP

[source,console]
--------------------------------------------------
DELETE _connector/my-connector
--------------------------------------------------
// TEARDOWN
////

[source,console]
----
GET _connector/my-connector
----