Delete ES|QL datasets

DELETE /_query/dataset/{name}

Deletes one or more datasets used in ES|QL data federation. If any specified dataset does not exist, the request fails and no datasets are deleted.

ES|QL Data Federation

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

DELETE /_query/dataset/access_logs

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.esql.delete_dataset(
    name="access_logs",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_query/dataset/access_logs" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.esql().deleteDataset(d -> d
    .name("access_logs")
);

PHP Elasticsearch PHP Client

$resp = $client->esql()->deleteDataset([
    "name" => "access_logs",
]);

Ruby Elasticsearch Ruby Client

response = client.esql.delete_dataset(
  name: "access_logs"
)

Response

The dataset definition was deleted successfully.

{
  "acknowledged": true
}