Elasticsearch

https://www.elastic.co/guide/en/elasticsearch/reference/8.19/
Admin
Elasticsearch is a distributed, open-source search and analytics engine designed for horizontal...
Tokens:4,937,301
Snippets:32,480
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Elasticsearch

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-minimal-setup.html

Start Elasticsearch on every node. This example assumes a .tar.gz installation and runs from the ES_HOME directory.

```bash
./bin/elasticsearch
```

--------------------------------

### Start trial API example response

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trial.html

Example response from the start trial API showing that the trial was started and the request was acknowledged.

```json
{
  "trial_was_started": true,
  "acknowledged": true
}
```

--------------------------------

### LOCATE example with start

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-functions-string.html

Example query using LOCATE with a start position of 5 to find the first occurrence of 'a' after that position, returning 10, with the output shown.

```sql
SELECT LOCATE('a', 'Elasticsearch', 5);

LOCATE('a', 'Elasticsearch', 5)
-------------------------------
10
```

--------------------------------

### Install and wait for completion with start /wait

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-odbc-installation.html

Installs the driver and waits for the process to finish, ensuring %ERRORLEVEL% is set correctly. Use start /wait because msiexec.exe runs in the Windows subsystem and does not wait by default.

```shell
start /wait msiexec.exe /i esodbc-8.19.22-windows-x86_64.msi /qn
```

--------------------------------

### Start Kibana

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/configuring-stack-security.html

Starts Kibana from the directory where it is installed.

```bash
bin/kibana
```

--------------------------------

### Start trial API examples

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trial.html

Starts a 30-day trial. The acknowledge parameter is required because you are initiating a license that will expire. The response indicates whether the trial was started and that it was acknowledged.

```python
resp = client.license.post_start_trial(
    acknowledge=True,
)
print(resp)
```

```ruby
response = client.license.post_start_trial(
  acknowledge: true
)
puts response
```

```javascript
const response = await client.license.postStartTrial({
  acknowledge: "true",
});
console.log(response);
```

```http
POST /_license/start_trial?acknowledge=true
```

--------------------------------

### Start Elasticsearch

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/configuring-stack-security.html

Starts Elasticsearch from the installation directory. On first start, it prints the elastic user password and an enrollment token for Kibana.

```bash
bin/elasticsearch
```

--------------------------------

### Get license API response example

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-license.html

Example response from the get license API for a trial license. Shows the license status, type, issue and expiry dates, and other metadata.

```json
{
  "license" : {
    "status" : "active",
    "uid" : "cbff45e7-c553-41f7-ae4f-9205eabd80xx",
    "type" : "trial",
    "issue_date" : "2018-10-20T22:05:12.332Z",
    "issue_date_in_millis" : 1540073112332,
    "expiry_date" : "2018-11-19T22:05:12.332Z",
    "expiry_date_in_millis" : 1542665112332,
    "max_nodes" : 1000,
    "max_resource_units" : null,
    "issued_to" : "test",
    "issuer" : "elasticsearch",
    "start_date_in_millis" : -1
  }
}
```

--------------------------------

### GET _migration/system_features example response

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/feature-migration-api.html

Example response from a GET request to `_migration/system_features`. Shows each feature with its `minimum_index_version`, `migration_status`, and `indices` array; the overall `migration_status` is `NO_MIGRATION_NEEDED`.

```json
{
  "features" : [
    {
      "feature_name" : "async_search",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "enrich",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "ent_search",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "fleet",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "geoip",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "kibana",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "logstash_management",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "machine_learning",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "searchable_snapshots",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "security",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "synonyms",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "tasks",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "transform",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "watcher",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    }
  ],
  "migration_status" : "NO_MIGRATION_NEEDED"
}
```

--------------------------------

### Get overall buckets with overall_score and start (REST)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

REST API example using GET request to retrieve overall buckets with overall_score and start parameters.

```json
GET _ml/anomaly_detectors/job-*/results/overall_buckets
{
  "overall_score": 80,
  "start": "1403532000000"
}
```

--------------------------------

### SHOW INFO example

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-commands.html

Example of SHOW INFO, which returns the deployment's version, build date, and hash.

```esql
SHOW INFO
```

--------------------------------

### Create data directory

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/es-connectors-tutorial-api.html

Creates a directory to store the example dataset for this tutorial.

```bash
mkdir -p ~/data
```

--------------------------------

### Example response for get basic status API

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-basic-status.html

Example response from the get basic status API. The `eligible_to_start_basic` field indicates whether you are eligible to start a basic license.

```json
{
  "eligible_to_start_basic": true
}
```

--------------------------------

### POST /_license/start_basic

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-basic.html

Starts an indefinite basic license. Requires `manage` cluster privileges.

```APIDOC
## [POST] /_license/start_basic

### Description
This API starts an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, you are notified in the response and must re-submit the request with the `acknowledge` parameter set to `true`.

### Method
POST

### Endpoint
/_license/start_basic

### Parameters
#### Query Parameters
- **acknowledge** (boolean) - Optional - Set to `true` to acknowledge that you are losing features if your current license has more features than a basic license.

### Request Example
POST /_license/start_basic?acknowledge=true

### Response
#### Success Response (200)
- **basic_was_started** (boolean) - Indicates whether the basic license was started.
- **acknowledged** (boolean) - Indicates whether the request was acknowledged.

#### Response Example
{
  "basic_was_started": true,
  "acknowledged": true
}
```

--------------------------------

### Get overall buckets with overall_score and start (Ruby)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

Ruby example using the Elasticsearch client to get overall buckets with a job_id wildcard, overall_score of 80, and start time. The response is printed.

```ruby
response = client.ml.get_overall_buckets(
  job_id: 'job-*',
  body: {
    overall_score: 80,
    start: '1403532000000'
  }
)
puts response
```

--------------------------------

### Initialize client with JavaScript modules

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-application-client.html

Create a client instance with search application name, URL, and API key. Optional configuration can be passed as the fourth argument.

```javascript
import Client from '@elastic/search-application-client'

const request = Client(
  'my-search-application', // search application name
  'url-from-connect-page', // url-host
  'api-key-from-connect-page',  // api-key
  {
    // optional configuration
  }
)
```

--------------------------------

### Start SQL CLI

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-cli.html

Launches the SQL CLI from the bin directory.

```bash
$ ./bin/elasticsearch-sql-cli
```

--------------------------------

### Get overall buckets with overall_score and start (Python)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

Python example using the Elasticsearch client to get overall buckets with a job_id wildcard, overall_score of 80, and start time. The response is printed.

```python
resp = client.ml.get_overall_buckets(
    job_id="job-*",
    overall_score=80,
    start="1403532000000",
)
print(resp)
```

--------------------------------

### Initialize client with CDN

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-application-client.html

Create a client instance using the CDN-loaded constructor with your search application details.

```html
<script>
  const request = Client(
    'my-example-app', // search application name
    'url-from-connect-page', // url-host
    'api-key-from-connect-page',  // api-key
    {
    // optional configuration
    }
)
</script>
```

--------------------------------

### Get overall buckets with overall_score and start (JavaScript)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

JavaScript example using the Elasticsearch client to get overall buckets with a job_id wildcard, overall_score of 80, and start time. The response is logged to the console.

```javascript
const response = await client.ml.getOverallBuckets({
  job_id: "job-*",
  overall_score: 80,
  start: 1403532000000,
});
console.log(response);
```

--------------------------------

### Response for get snapshots by prefix and start time

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-api.html

Example response for the get snapshot API when filtering by prefix and start time. Shows three snapshots with metadata such as state, timestamps, and shard counts.

```json
{
  "snapshots": [
    {
      "snapshot": "snapshot_1",
      "uuid": "dKb54xw67gvdRctLCxSket",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.128Z",
      "start_time_in_millis": 1593093628849,
      "end_time": "2020-07-06T21:55:18.129Z",
      "end_time_in_millis": 1593093628850,
      "duration_in_millis": 1,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    },
    {
      "snapshot": "snapshot_2",
      "uuid": "vdRctLCxSketdKb54xw67g",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.130Z",
      "start_time_in_millis": 1593093628851,
      "end_time": "2020-07-06T21:55:18.130Z",
      "end_time_in_millis": 1593093628851,
      "duration_in_millis": 0,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    },
    {
      "snapshot": "snapshot_3",
      "uuid": "dRctdKb54xw67gvLCxSket",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.131Z",
      "start_time_in_millis": 1593093628852,
      "end_time": "2020-07-06T21:55:18.135Z",
      "end_time_in_millis": 1593093628856,
      "duration_in_millis": 4,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    }
  ],
  "total": 3,
  "remaining": 0
}
```

--------------------------------

### Create index, bulk index documents, and run top_metrics aggregation (Python)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-aggregations-metrics-top-metrics.html

Python client example that creates an index with a date field, indexes three documents, and runs a top_metrics aggregation with multiple metrics and a sort on field 's' descending.

```python
resp = client.indices.create(
    index="test",
    mappings={
        "properties": {
            "d": {
                "type": "date"
            }
        }
    },
)
print(resp)

resp1 = client.bulk(
    index="test",
    refresh=True,
    operations=[
        {
            "index": {}
        },
        {
            "s": 1,
            "m": 3.1415,
            "i": 1,
            "d": "2020-01-01T00:12:12Z",
            "t": "cat"
        },
        {
            "index": {}
        },
        {
            "s": 2,
            "m": 1,
            "i": 6,
            "d": "2020-01-02T00:12:12Z",
            "t": "dog"
        },
        {
            "index": {}
        },
        {
            "s": 3,
            "m": 2.71828,
            "i": -12,
            "d": "2019-12-31T00:12:12Z",
            "t": "chicken"
        }
    ],
)
print(resp1)

resp2 = client.search(
    index="test",
    filter_path="aggregations",
    aggs={
        "tm": {
            "top_metrics": {
                "metrics": [
                    {
                        "field": "m"
                    },
                    {
                        "field": "i"
                    },
                    {
                        "field": "d"
                    },
                    {
                        "field": "t.keyword"
                    }
                ],
                "sort": {
                    "s": "desc"
                }
            }
        }
    },
)
print(resp2)
```

--------------------------------

### JavaScript: Get buckets with anomaly_score and start

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-bucket.html

JavaScript example using the Elasticsearch client to call ml.getBuckets with job_id, anomaly_score, and start parameters.

```javascript
const response = await client.ml.getBuckets({
  job_id: "low_request_rate",
  anomaly_score: 80,
  start: 1454530200001,
});
console.log(response);
```

--------------------------------

### POST /_license/start_trial

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/analysis-chargroup-tokenizer.html

Starts a trial license on the cluster.

```APIDOC
## [POST] /_license/start_trial

### Description
Starts a trial license on the cluster.

### Method
POST

### Endpoint
/_license/start_trial

### Response
#### Success Response (200)
- **acknowledged** (boolean) - Whether the request was acknowledged.
- **trial_was_started** (boolean) - Whether the trial was started.

#### Response Example
{
  "acknowledged": true,
  "trial_was_started": true
}
```

--------------------------------

### Python: Get buckets with anomaly_score and start

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-bucket.html

Python example using the Elasticsearch client to call ml.get_buckets with job_id, anomaly_score, and start parameters.

```python
resp = client.ml.get_buckets(
    job_id="low_request_rate",
    anomaly_score=80,
    start="1454530200001",
)
print(resp)
```

--------------------------------

### Get overall buckets with top_n 2 (REST)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

REST API example using GET request to retrieve overall buckets with top_n, overall_score, and start parameters.

```json
GET _ml/anomaly_detectors/job-*/results/overall_buckets
{
  "top_n": 2,
  "overall_score": 50.0,
  "start": "1403532000000"
}
```

--------------------------------

### Import example data into PostgreSQL

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/es-connectors-tutorial-api.html

Copies the sample data into the container and executes the psql script to import the data and create tables.

```bash
docker cp ~/data/Chinook_PostgreSql.sql postgres:/
docker exec -it postgres psql -U myuser -f /Chinook_PostgreSql.sql
```

--------------------------------

### Ruby: Get buckets with anomaly_score and start

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-bucket.html

Ruby example using the Elasticsearch client to call ml.get_buckets with job_id and body parameters.

```ruby
response = client.ml.get_buckets(
  job_id: 'low_request_rate',
  body: {
    anomaly_score: 80,
    start: '1454530200001'
  }
)
puts response
```

--------------------------------

### Create index, bulk index documents, and run top_metrics aggregation (Ruby)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-aggregations-metrics-top-metrics.html

Ruby client example that creates an index with a date field, indexes three documents, and runs a top_metrics aggregation with multiple metrics and a sort on field 's' descending.

```ruby
response = client.indices.create(
  index: 'test',
  body: {
    mappings: {
      properties: {
        d: {
          type: 'date'
        }
      }
    }
  }
)
puts response

response = client.bulk(
  index: 'test',
  refresh: true,
  body: [
    {
      index: {}
    },
    {
      s: 1,
      m: 3.1415,
      i: 1,
      d: '2020-01-01T00:12:12Z',
      t: 'cat'
    },
    {
      index: {}
    },
    {
      s: 2,
      m: 1,
      i: 6,
      d: '2020-01-02T00:12:12Z',
      t: 'dog'
    },
    {
      index: {}
    },
    {
      s: 3,
      m: 2.71828,
      i: -12,
      d: '2019-12-31T00:12:12Z',
      t: 'chicken'
    }
  ]
)
puts response

response = client.search(
  index: 'test',
  filter_path: 'aggregations',
  body: {
    aggregations: {
      tm: {
        top_metrics: {
          metrics: [
            {
              field: 'm'
            },
            {
              field: 'i'
            },
            {
              field: 'd'
            },
            {
              field: 't.keyword'
            }
          ],
          sort: {
            s: 'desc'
          }
        }
      }
    }
  }
)
puts response
```

--------------------------------

### Get overall buckets with top_n 2 (Ruby)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

Ruby example using the Elasticsearch client to get overall buckets with top_n set to 2, overall_score of 50, and start time. The response is printed.

```ruby
response = client.ml.get_overall_buckets(
  job_id: 'job-*',
  body: {
    top_n: 2,
    overall_score: 50,
    start: '1403532000000'
  }
)
puts response
```

--------------------------------

### Get overall buckets with top_n 2 (Python)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

Python example using the Elasticsearch client to get overall buckets with top_n set to 2, overall_score of 50, and start time. The response is printed.

```python
resp = client.ml.get_overall_buckets(
    job_id="job-*",
    top_n=2,
    overall_score=50,
    start="1403532000000",
)
print(resp)
```

--------------------------------

### Get overall buckets with top_n 2 (JavaScript)

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html

JavaScript example using the Elasticsearch client to get overall buckets with top_n set to 2, overall_score of 50, and start time. The response is logged to the console.

```javascript
const response = await client.ml.getOverallBuckets({
  job_id: "job-*",
  top_n: 2,
  overall_score: 50,
  start: 1403532000000,
});
console.log(response);
```

--------------------------------

### Install with log file using /l argument

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/sql-odbc-installation.html

Installs the driver and writes a log file to the specified path using the /l argument. Without /l, a log file is created in %TEMP% with a randomly generated name like MSI<random>.LOG.

```shell
start /wait msiexec.exe /i esodbc-8.19.22-windows-x86_64.msi /qn /l install.log
```

--------------------------------

### FROM basic example

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-commands.html

Basic example of the FROM command returning a table with data from the employees index.

```esql
FROM employees
```

--------------------------------

### Get trial status API examples

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trial-status.html

Checks whether you are eligible to start a trial. The response includes the field "eligible_to_start_trial".

```python
resp = client.license.get_trial_status()
print(resp)
```

```ruby
response = client.license.get_trial_status
puts response
```

```javascript
const response = await client.license.getTrialStatus();
console.log(response);
```

```console
GET /_license/trial_status
```

--------------------------------

### Check basic license status with get_basic_status API

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-basic-status.html

These examples check whether you are eligible to start a basic license using the get basic status API. The Python, Ruby, and JavaScript examples use the respective Elasticsearch client libraries, while the HTTP example shows the raw request.

```python
resp = client.license.get_basic_status()
print(resp)
```

```ruby
response = client.license.get_basic_status
puts response
```

```javascript
const response = await client.license.getBasicStatus();
console.log(response);
```

```http
GET /_license/basic_status
```

--------------------------------

### Help parameter response

Source: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat.html

Example response from `_cat/master?help`, listing the available columns with their aliases and descriptions.

```text
id   |   | node id
host | h | host name
ip   |   | ip address
node | n | node name

```
Tokens:
Raw