Get ES|QL data sources

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

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

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

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")
);

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::"
      }
    }
  ]
}