Snapshots

How to access snapshot information of a database cluster.

Get the snapshots of your cluster

get

Retrieves MongoDB snapshots.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Query parameters

limitinteger · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with 'offset' for pagination.

Default: 100Example: 100

offsetintegerOptional

The first element to return. Use together with 'limit' for pagination.

Default: 0Example: 200

Responses

200

Successful operation.

application/json

Responseall of

List of snapshots.

and

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

get

HTTPcURLJavaScriptPython

GET /databases/mongodb/clusters/{clusterId}/snapshots HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "collection",
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "items": [
    {
      "type": "snapshot",
      "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
      "properties": {
        "version": "5.0",
        "size": 150,
        "creationTime": "2020-12-10T13:37:50+01:00"
      }
    }
  ],
  "offset": 200,
  "limit": 100,
  "links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}