Get model snapshots info

POST also GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
POST also GET /_ml/anomaly_detectors/{job_id}/model_snapshots

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

Request body

Response

application/json

count number required
model_snapshots object[] required

Examples

Request Console 1 / 8 languages

An example body for a GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots request.

Console Kibana Dev Tools

POST _ml/anomaly_detectors/high_sum_total_sales/model_snapshots
{
  "start": "1575402236000"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getModelSnapshots({
  job_id: "high_sum_total_sales",
  start: 1575402236000,
});

Python Elasticsearch Python Client

resp = client.ml.get_model_snapshots(
    job_id="high_sum_total_sales",
    start="1575402236000",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/high_sum_total_sales/model_snapshots" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "start": "1575402236000"
  }'

Java Elasticsearch Java Client

client.ml().getModelSnapshots(g -> g
    .jobId("high_sum_total_sales")
    .start(DateTime.of("1575402236000"))
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetModelSnapshotsAsync(new GetModelSnapshotsRequest()
    {
        JobId = "high_sum_total_sales",
        Start = DateTimeOffset.Parse("2019-12-03T19:43:56.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind)
    });

PHP Elasticsearch PHP Client

$resp = $client->ml()->getModelSnapshots([
    "job_id" => "high_sum_total_sales",
    "body" => [
        "start" => "1575402236000",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_model_snapshots(
  job_id: "high_sum_total_sales",
  body: {
    "start": "1575402236000"
  }
)

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body