- Elasticsearch Guide: other versions:
- What’s new in 8.17
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Re-ranking
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- Connectors
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Cross-cluster replication
- Data store architecture
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector features
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Claim connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Delete inference API
- Get inference API
- Perform inference API
- Create inference API
- Stream inference API
- Update inference API
- AlibabaCloud AI Search inference service
- Amazon Bedrock inference service
- Anthropic inference service
- Azure AI studio inference service
- Azure OpenAI inference service
- Cohere inference service
- Elasticsearch inference service
- ELSER inference service
- Google AI Studio inference service
- Google Vertex AI inference service
- HuggingFace inference service
- Mistral inference service
- OpenAI inference service
- Watsonx inference service
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Bulk create or update roles API
- Bulk delete roles API
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Query Role
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- Optimizations
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- Migration guide
- Release notes
- Elasticsearch version 8.17.1
- Elasticsearch version 8.17.0
- Elasticsearch version 8.16.2
- Elasticsearch version 8.16.1
- Elasticsearch version 8.16.0
- Elasticsearch version 8.15.5
- Elasticsearch version 8.15.4
- Elasticsearch version 8.15.3
- Elasticsearch version 8.15.2
- Elasticsearch version 8.15.1
- Elasticsearch version 8.15.0
- Elasticsearch version 8.14.3
- Elasticsearch version 8.14.2
- Elasticsearch version 8.14.1
- Elasticsearch version 8.14.0
- Elasticsearch version 8.13.4
- Elasticsearch version 8.13.3
- Elasticsearch version 8.13.2
- Elasticsearch version 8.13.1
- Elasticsearch version 8.13.0
- Elasticsearch version 8.12.2
- Elasticsearch version 8.12.1
- Elasticsearch version 8.12.0
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Get snapshot API
editGet snapshot API
editRetrieves information about one or more snapshots.
resp = client.snapshot.get( repository="my_repository", snapshot="my_snapshot", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'my_snapshot' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "my_snapshot", }); console.log(response);
GET /_snapshot/my_repository/my_snapshot
Request
editGET /_snapshot/<repository>/<snapshot>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor_snapshot
,create_snapshot
, ormanage
cluster privilege to use this API.
Path parameters
edit-
<repository>
-
(Required, string) Comma-separated list of snapshot repository names used to limit the request. Wildcard (
*
) expressions are supported including combining wildcards with exclude patterns starting with-
.To get information about all snapshot repositories registered in the cluster, omit this parameter or use
*
or_all
. -
<snapshot>
-
(Required, string) Comma-separated list of snapshot names to retrieve. Wildcard (
*
) expressions are supported including combining wildcards with exclude patterns starting with-
.-
To get information about all snapshots in a registered repository, use a wildcard (
*
) or_all
. -
To get information about any snapshots that are currently running, use
_current
.Using
_all
in a request fails if any snapshots are unavailable. Setignore_unavailable
totrue
to return only available snapshots.
-
To get information about all snapshots in a registered repository, use a wildcard (
Query parameters
edit-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.
-
ignore_unavailable
-
(Optional, Boolean) If
false
, the request returns an error for any snapshots that are unavailable. Defaults tofalse
.If
true
, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. -
verbose
-
(Optional, Boolean)
If
true
, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. Defaults totrue
. Iffalse
, omits the additional information. -
index_names
-
(Optional, Boolean)
If
true
, returns the list of index names included in each snapshot in the response. Defaults totrue
. -
index_details
-
(Optional, Boolean)
If
true
, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults tofalse
, meaning that this information is omitted. -
include_repository
-
(Optional, Boolean)
If
true
, returns the repository name for each snapshot in the response. Defaults totrue
. -
sort
-
(Optional, string) Allows setting a sort order for the result. Defaults to
start_time
, i.e. sorting by snapshot start time stamp.Valid values for
sort
-
start_time
- Sort snapshots by their start time stamp and break ties by snapshot name.
-
duration
- Sort snapshots by their duration and break ties by snapshot name.
-
name
- Sort snapshots by their name.
-
repository
- Sort snapshots by their repository name and break ties by snapshot name.
-
index_count
- Sort snapshots by the number of indices they contain and break ties by snapshot name.
-
shard_count
- Sort snapshots by the number of shards they contain and break ties by snapshot name.
-
failed_shard_count
- Sort snapshots by the number of shards that they failed to snapshot and break ties by snapshot name.
-
-
size
-
(Optional, integer)
Maximum number of snapshots to return. Defaults to
0
which means return all that match the request without limit. -
order
-
(Optional, string)
Sort order. Valid values are
asc
for ascending anddesc
for descending order. Defaults toasc
, meaning ascending order. -
from_sort_value
- (Optional, string) Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count.
-
after
-
(Optional, string)
Offset identifier to start pagination from as returned by the
next
field in the response body. Using this parameter is mutually exclusive with using thefrom_sort_value
parameter. -
offset
-
(Optional, integer)
Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually
exclusive with using the
after
parameter. Defaults to0
. -
slm_policy_filter
-
(Optional, string)
Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (
\*
) and combinations of wildcards followed by exclude patterns starting with-
. For example, the pattern*,-policy-a-\*
will return all snapshots except for those that were created by an SLM policy with a name starting withpolicy-a-
. Note that the wildcard pattern*
matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots not created by an SLM policy you can use the special pattern_none
that will match all snapshots without an SLM policy.
The after
parameter and next
field allow for iterating through snapshots with some consistency guarantees regarding concurrent
creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently
deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration.
The parameters size
, order
, after
, from_sort_value
, offset
, slm_policy_filter
and sort
are not supported when using
verbose=false
and the sort order for requests with verbose=false
is undefined.
Response body
edit-
snapshot
- (string) Name of the snapshot.
-
uuid
- (string) Universally unique identifier (UUID) of the snapshot.
-
version_id
- (int) Build ID of the Elasticsearch version used to create the snapshot.
-
version
- (float) Elasticsearch version used to create the snapshot.
-
indices
- (array) List of indices included in the snapshot.
-
index_details
-
(object) Details of each index in the snapshot, keyed by index name. Only present if the
?index_details
query parameter is set, and only contains details for indices that were completely snapshotted in a sufficiently recent version of Elasticsearch.Properties of
index_details
-
shard_count
- (integer) Number of shards in this index.
-
size
-
(string)
Total size of all shards in this index. Only present if the
?human
query paramter is set. -
size_in_bytes
- (long) Total size of all shards in this index, in bytes.
-
max_segments_per_shard
- (integer) Maximum number of segments per shard in this index snapshot.
-
-
data_streams
- (array of strings) List of data streams included in the snapshot.
-
include_global_state
- (Boolean) Indicates whether the current cluster state is included in the snapshot.
-
feature_states
-
(array of objects) Feature states in the snapshot. Only present if the snapshot contains one or more feature states.
Properties of
features_states
objects-
feature_name
- (string) Name of the feature, as returned by the get features API.
-
indices
- (array of strings) Indices in the feature state.
-
-
start_time
- (string) Date timestamp of when the snapshot creation process started.
-
start_time_in_millis
- (long) The time, in milliseconds, when the snapshot creation process started.
-
end_time
- (string) Date timestamp of when the snapshot creation process ended.
-
end_time_in_millis
- (long) The time, in milliseconds, when the snapshot creation process ended.
-
duration_in_millis
- (long) How long, in milliseconds, it took to create the snapshot.
-
failures
- (array) Lists any failures that occurred when creating the snapshot.
-
shards
-
(object) Contains a count of shards in the snapshot.
Properties of
shards
-
total
- (integer) Total number of shards included in the snapshot.
-
successful
- (integer) Number of shards that were successfully included in the snapshot.
-
failed
- (integer) Number of shards that failed to be included in the snapshot.
-
-
state
-
(string) The snapshot
state
can be one of the following values:Values for
state
-
IN_PROGRESS
- The snapshot is currently running.
-
SUCCESS
- The snapshot finished and all shards were stored successfully.
-
FAILED
- The snapshot finished with an error and failed to store any data.
-
PARTIAL
-
The global cluster state was stored, but data of at least one shard was not stored successfully.
The
failures
section of the response contains more detailed information about shards that were not processed correctly.
-
-
next
-
(string)
If the request contained a size limit and there might be more results, a
next
field will be added to the response and can be used as theafter
query parameter to fetch additional results. -
total
-
(integer)
The total number of snapshots that match the request when ignoring size limit or
after
query parameter. -
remaining
-
(integer)
The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the
next
field value.
Examples
editThe following request returns information for snapshot_2
in the my_repository
repository.
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot_2", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot_2' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot_2", }); console.log(response);
GET /_snapshot/my_repository/snapshot_2
The API returns the following response:
{ "snapshots": [ { "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "total": 1, "remaining": 0 }
The following request returns information for all snapshots with prefix snapshot
in the my_repository
repository,
limiting the response size to 2 and sorting by snapshot name.
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot*", size="2", sort="name", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot*', size: 2, sort: 'name' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot*", size: 2, sort: "name", }); console.log(response);
GET /_snapshot/my_repository/snapshot*?size=2&sort=name
The API returns the following response:
{ "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "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": 1593094752019, "duration_in_millis": 1, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "next": "c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=", "total": 3, "remaining": 1 }
A subsequent request for the remaining snapshots can then be made using the next
value from the previous response as after
parameter.
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot*", size="2", sort="name", after="c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot*', size: 2, sort: 'name', after: 'c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot*", size: 2, sort: "name", after: "c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=", }); console.log(response);
GET /_snapshot/my_repository/snapshot*?size=2&sort=name&after=c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=
The API returns the following response:
{ "snapshots": [ { "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "total": 3, "remaining": 0 }
Alternatively, the same result could be retrieved by using an offset value of 2
to skip the two snapshot already seen.
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot*", size="2", sort="name", offset="2", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot*', size: 2, sort: 'name', offset: 2 ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot*", size: 2, sort: "name", offset: 2, }); console.log(response);
GET /_snapshot/my_repository/snapshot*?size=2&sort=name&offset=2
The API returns the following response:
{ "snapshots": [ { "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "total": 3, "remaining": 0 }
The following request returns information for all snapshots with prefix snapshot
in the my_repository
repository,
except for the one named snapshot_3
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot*,-snapshot_3", sort="name", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot*,-snapshot_3', sort: 'name' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot*,-snapshot_3", sort: "name", }); console.log(response);
GET /_snapshot/my_repository/snapshot*,-snapshot_3?sort=name
The API returns the following response:
{ "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "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": 1593094752019, "duration_in_millis": 1, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "total": 2, "remaining": 0 }
The following request returns information for all snapshots that come after snapshot_2
when sorted by snapshot name in the default
ascending order.
resp = client.snapshot.get( repository="my_repository", snapshot="*", sort="name", from_sort_value="snapshot_2", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: '*', sort: 'name', from_sort_value: 'snapshot_2' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "*", sort: "name", from_sort_value: "snapshot_2", }); console.log(response);
GET /_snapshot/my_repository/*?sort=name&from_sort_value=snapshot_2
The API returns the following response:
{ "snapshots": [ { "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": 1593094752019, "duration_in_millis": 1, "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.129Z", "start_time_in_millis": 1593093628850, "end_time": "2020-07-06T21:55:18.129Z", "end_time_in_millis": 1593094752018, "duration_in_millis": 0, "failures": [], "shards": { "total": 0, "failed": 0, "successful": 0 } } ], "total": 2, "remaining": 0 }
The following request returns information for all snapshots with names starting with snapshot_
and that started on or after timestamp
1577833200000
(Jan 1st 2020) when sorted by snapshot start time in the default ascending order.
resp = client.snapshot.get( repository="my_repository", snapshot="snapshot_*", sort="start_time", from_sort_value="1577833200000", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: 'snapshot_*', sort: 'start_time', from_sort_value: 1_577_833_200_000 ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "snapshot_*", sort: "start_time", from_sort_value: 1577833200000, }); console.log(response);
GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000
The API returns the following response:
{ "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 }