Elastic Stack

Elastic Stack (ELK Stack) Snapshot API

The snapshot API from Elastic Stack (ELK Stack) — 12 operation(s) for snapshot.

GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /_snapshot/{repository}/_cleanup Clean up stale data in a snapshot repository · Clean up the snapshot repository #
Ask an LLM
“How do I delete leftover files in a snapshot repository that no snapshot references anymore?”
“What cluster privilege do I need to clean up a snapshot repository?”
Tell an agent destructive · confirm first
Clean up unreferenced data in snapshot repository {repository}.
Purge stale blobs from repository {repository}, waiting up to {timeout} for nodes.
PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot} Clone a snapshot within the same repository · Clone a snapshot #
Ask an LLM
“Can I copy some indices from an existing snapshot into a new snapshot?”
“Does cloning a snapshot have to stay in the same repository?”
Tell an agent
Clone snapshot {snapshot} in {repository} to {target_snapshot} with indices {indices}.
Make a copy named {target_snapshot} of just the {indices} indices from snapshot {snapshot} in repo {repository}.
GET /_snapshot/{repository}/{snapshot} Get information about snapshots · Get snapshot information #
Ask an LLM
“How do I list the snapshots stored in a repository?”
“Can I show only failed or partial snapshots, sorted by start time?”
Tell an agent
List snapshots {snapshot} in repository {repository}.
Show snapshots in {repository} matching {snapshot} whose state is {state}.
PUT /_snapshot/{repository}/{snapshot} Take a snapshot (PUT form) · Create a snapshot #
Ask an LLM
“How do I back up my cluster's indices to a snapshot repository with a PUT request?”
“Can the PUT snapshot call wait until the snapshot is finished before returning?”
Tell an agent
Using PUT, take snapshot {snapshot} in repository {repository}.
PUT a snapshot {snapshot} of indices {indices} into {repository} and wait for completion.
POST /_snapshot/{repository}/{snapshot} Take a snapshot (POST form) · Create a snapshot #
Ask an LLM
“Is there a POST variant for creating a snapshot of data streams and indices?”
“Can a snapshot created by POST include the global cluster state?”
Tell an agent
Using POST, create snapshot {snapshot} in repository {repository}.
POST a snapshot {snapshot} to {repository} with include_global_state set to {include_global_state}.
DELETE /_snapshot/{repository}/{snapshot} Delete snapshots · Delete snapshots #
Ask an LLM
“How do I delete old snapshots from a repository?”
“Can I delete several snapshots at once using a wildcard?”
Tell an agent destructive · confirm first
Delete snapshot {snapshot} from repository {repository}.
Remove every snapshot in {repository} matching {snapshot}.
GET /_snapshot/{repository} Get settings of named snapshot repositories · Get snapshot repository information #
Ask an LLM
“How do I see the type and settings of one specific snapshot repository?”
“Can I read a named repository's configuration from the local node only?”
Tell an agent
Show the configuration of snapshot repository {repository}.
Get repository {repository} settings from the local node when local is {local}.
PUT /_snapshot/{repository} Register or update a snapshot repository (PUT) · Create or update a snapshot repository #
Ask an LLM
“How do I register a new snapshot repository with a PUT request?”
“Can the PUT repository call verify the repository works on every node?”
Tell an agent
Using PUT, register snapshot repository {repository}.
PUT an update to repository {repository} with verify set to {verify}.
POST /_snapshot/{repository} Register or update a snapshot repository (POST) · Create or update a snapshot repository #
Ask an LLM
“Is there a POST form for registering a snapshot repository?”
“What must be true of cluster metadata before a repository can be registered via POST?”
Tell an agent
Using POST, register or update snapshot repository {repository}.
POST repository {repository} and allow {timeout} for the nodes to respond.
DELETE /_snapshot/{repository} Unregister snapshot repositories · Delete snapshot repositories #
Ask an LLM
“Does unregistering a snapshot repository delete the snapshots stored in it?”
“How do I remove a snapshot repository from my cluster?”
Tell an agent destructive · confirm first
Unregister snapshot repository {repository}.
Remove the repository references matching {repository} from the cluster.
GET /_snapshot List all snapshot repositories · Get snapshot repository information #
Ask an LLM
“Which snapshot repositories are registered on my cluster?”
“What repositories can I back up to right now?”
Tell an agent
List every registered snapshot repository.
Show all snapshot repositories as seen by the local node.
POST /_snapshot/{repository}/_analyze Stress-test a snapshot repository's storage · Analyze a snapshot repository #
Ask an LLM
“How can I check that my third-party storage behaves correctly as a snapshot repository?”
“Can I control how many blobs and how much data the repository analysis writes?”
Tell an agent
Analyze snapshot repository {repository} for incorrect behaviour.
Run a repository analysis on {repository} writing {blob_count} blobs up to {max_total_data_size} total.
POST /_snapshot/{repository}/_verify_integrity Verify the integrity of a snapshot repository · Verify the repository integrity #
Ask an LLM
“How do I check a repository's contents for corruption that would stop a restore?”
“Can the integrity check verify the checksum of every data blob?”
Tell an agent
Verify the integrity of repository {repository}.
Check every blob checksum in {repository} with verify_blob_contents set to {verify_blob_contents}.
POST /_snapshot/{repository}/{snapshot}/_restore Restore a snapshot · Restore a snapshot #
Ask an LLM
“How do I restore indices from a snapshot into my running cluster?”
“Can I rename indices as they're restored so they don't clash with existing ones?”
Tell an agent
Restore snapshot {snapshot} from repository {repository}.
Restore indices {indices} from {snapshot} in {repository}, renaming {rename_pattern} to {rename_replacement}.
GET /_snapshot/_status Get shard status of all running snapshots · Get the snapshot status #
Ask an LLM
“How do I see shard-level progress for every snapshot currently running?”
“What snapshots are in progress across all repositories right now?”
Tell an agent
Show the status of all currently running snapshots.
Get shard-level progress for every in-flight snapshot in the cluster.
GET /_snapshot/{repository}/_status Get status of running snapshots in a repository · Get the snapshot status #
Ask an LLM
“Can I check progress only for the snapshots running in one repository?”
“Which in-progress snapshots in a given repository are still copying shards?”
Tell an agent
Show the status of running snapshots in repository {repository}.
Get shard progress for in-flight snapshots stored in {repository}.
GET /_snapshot/{repository}/{snapshot}/_status Get detailed status of specific snapshots · Get the snapshot status #
Ask an LLM
“How do I get the per-shard status of one named snapshot?”
“Can I get per-shard status for a specific snapshot that has already finished?”
Tell an agent
Get the detailed status of snapshot {snapshot} in {repository}.
Show shard-by-shard state for snapshots {snapshot} in repository {repository}.
POST /_snapshot/{repository}/_verify Check a snapshot repository for misconfiguration · Verify a snapshot repository #
Ask an LLM
“How do I confirm a newly registered repository is reachable from all nodes?”
“Is there a quick check for common snapshot repository misconfigurations?”
Tell an agent
Verify snapshot repository {repository}.
Quick-check {repository} for common misconfigurations.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-snapshot-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-snapshot-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-snapshot-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elk Stack Snapshot API
  version: '1.0'
  description: 'Operations tagged snapshot across 2 of this provider''s published API definitions: elk-stack-elasticsearch-openapi.json, elk-stack-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:9200
  description: Default local Elasticsearch endpoint
- url: https://{host}:{port}
  description: Self-hosted or Elastic Cloud cluster endpoint
  variables:
    host:
      default: localhost
    port:
      default: '9200'
tags:


# --- truncated at 32 KB (614 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-snapshot-api-openapi.yml