Delete ES|QL data sources

DELETE /_query/data_source/{name}

Auth

Deletes one or more data sources used in ES|QL data federation. Fails with 409 if any dataset references one of the named data sources; delete the dependent datasets first.

ES|QL Data Federation

Required privileges

Cluster privileges manage

Path parameters

name union string | string[] required: A comma-separated list of data source names to delete.

Query parameters

master_timeout string · default: 30s: Period to wait for a connection to the master node.
timeout string · default: 30s: The time to wait for the request to be completed.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_query/data_source/prod_s3_logs

JavaScript Elasticsearch JavaScript Client

const response = await client.esql.deleteDataSource({
  name: "prod_s3_logs",
});

Python Elasticsearch Python Client

resp = client.esql.delete_data_source(
    name="prod_s3_logs",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_query/data_source/prod_s3_logs" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.esql().deleteDataSource(d -> d
    .name("prod_s3_logs")
);

C# Elasticsearch .NET Client

var response = await client.Esql.DeleteDataSourceAsync(name: new[] { "prod_s3_logs" });

PHP Elasticsearch PHP Client

$resp = $client->esql()->deleteDataSource([
    "name" => "prod_s3_logs",
]);

Ruby Elasticsearch Ruby Client

response = client.esql.delete_data_source(
  name: "prod_s3_logs"
)

Response

The data source configuration was deleted successfully.

{
  "acknowledged": true
}