This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Update connector configuration API Update connector features API »

› › ›

Update connector index name API

edit

Update connector index name API

edit

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.

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

To get started with Connector APIs, check out our tutorial.

Request

edit

PUT _connector/<connector_id>/_index_name

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 Elastic managed connectors.
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:

resp = client.connector.update_index_name(
    connector_id="my-connector",
    index_name="data-from-my-google-drive",
)
print(resp)

response = client.connector.update_index_name(
  connector_id: 'my-connector',
  body: {
    index_name: 'data-from-my-google-drive'
  }
)
puts response

const response = await client.connector.updateIndexName({
  connector_id: "my-connector",
  index_name: "data-from-my-google-drive",
});
console.log(response);

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

{
    "result": "updated"
}

« Update connector configuration API Update connector features API »