Update connector index name API

edit

Update connector index name API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Updates the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

Request

edit

PUT _connector/<connector_id>/_index_name

Prerequisites

edit
  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • The connector_id parameter should reference an existing connector.

Path parameters

edit
<connector_id>
(Required, string)

Request body

edit
index_name
(Required, string) Index name where the connector ingests data. Each index name can be associated with at most one connector.

Response codes

edit
200
Connector index_name field was successfully updated.
400
The connector_id was not provided or the request payload was malformed.
404 (Missing resources)
No connector matching connector_id could be found.

Examples

edit

The following example updates the index_name field for the connector with ID my-connector:

PUT _connector/my-connector/_index_name
{
    "index_name": "data-from-my-google-drive"
}
{
    "result": "updated"
}