Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Managed Service for Elasticsearch
  • Getting started
  • Access management
  • Pricing policy
  • CLI reference
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  1. API reference
  2. REST
  3. Backup
  4. Get

Managed Service for Elasticsearch API, REST: Backup.Get

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Path parameters
  • Response

Returns the specified backup of Elasticsearch cluster.

HTTP requestHTTP request

GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/backups/{backupId}

Path parametersPath parameters

Field

Description

backupId

string

Required field. Required. ID of the backup to return.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "sourceClusterId": "string",
  "startedAt": "string",
  "createdAt": "string",
  "indices": [
    "string"
  ],
  "elasticsearchVersion": "string",
  "sizeBytes": "string",
  "indicesTotal": "string"
}

Field

Description

id

string

Required. ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

sourceClusterId

string

ID of the associated Elasticsearch cluster.

startedAt

string (date-time)

The time when the backup operation was started.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdAt

string (date-time)

The time when the backup was created (i.e. when the backup operation completed).

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

indices[]

string

Indices names. (max 100)

elasticsearchVersion

string

Elasticsearch version used to create the snapshot

sizeBytes

string (int64)

Total size of all indices in backup. in bytes

indicesTotal

string (int64)

Total count of indices in backup

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC