Get ES|QL data sources

GET /_query/data_source/{name}
GET /_query/data_source

Auth

Returns one or more data sources used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

ES|QL Data Federation

Required authorization

Cluster privileges manage

Path parameters

name union string | string[] optional

A comma-separated list of data source names or wildcard patterns. Omit to return all data sources.

Leave it out to use /_query/data_source.

Query parameters

master_timeout string · default: 30s: Period to wait for a connection to the master node.

Response

application/json

data_sources object[] required: The matching data sources. Credential values in each data source's settings are redacted as ::es_redacted:: in the response.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_query/data_source/prod_s3_logs

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.esql().getDataSource(g -> g
    .name("prod_s3_logs")
);

C# Elasticsearch .NET Client

var response = await client.Esql
    .GetDataSourceAsync(d1 => d1
        .Name(new[] { "prod_s3_logs" })
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

The response contains the requested data source. Credential values are replaced by the <>es_redacted sentinel.

{
  "data_sources": [
    {
      "name": "prod_s3_logs",
      "type": "s3",
      "description": "Production S3 logs bucket",
      "settings": {
        "region": "us-east-1",
        "auth": "static_credentials",
        "access_key": "::es_redacted::",
        "secret_key": "::es_redacted::"
      }
    }
  ]
}