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

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

beta::[]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs].
--

Retrieves the details about a connector.

To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


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

`GET _connector/<connector_id>`

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

* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

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