mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
750a0ab846
* [Connector API] Add interface for soft-deletes * Define connector deleted system index * Got soft-delete logic working * Add unit tests * Add yaml e2e test and attempt to update permissions * Fix permissions * Update docs * Fix docs * Update docs/changelog/118282.yaml * Change logic * Fix tests * Remove unnecessary privilege from yaml rest test * Update changelog * Update docs/changelog/118669.yaml * Adapt yaml tests * Undo changes to muted-tests.yml * Fix compilation issue after other PR got merged * Exclude soft-deleted connector from checks about index_name already in use * Update docs/reference/connector/apis/get-connector-api.asciidoc Co-authored-by: Tim Grein <tim@4greins.de> * Update rest-api-spec/src/main/resources/rest-api-spec/api/connector.list.json Co-authored-by: Tim Grein <tim@4greins.de> * Adapt comments, add connector wire serializing test * Introduce new transport versions for passing the delete flag * Get rid of wire serialisation, use include_deleted instead of deleted flag * Remove unused import * Final tweaks * Adapt variable name in rest layer --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Tim Grein <tim@4greins.de>
76 lines
1.8 KiB
Text
76 lines
1.8 KiB
Text
[[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)
|
|
|
|
`include_deleted`::
|
|
(Optional, boolean) A flag indicating whether to also return connectors that have been soft-deleted. Defaults to `false`.
|
|
|
|
[[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
|
|
----
|