Retrieve Snapshot

Returns the Snapshot by ID.

get

/snapshots/{snapshotId}

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

snapshotIdstring · uuidRequired

The ID (UUID) of the Snapshot.

Example: a8784665-3d99-5464-af32-30a2967f58e7

Responses

200

Getting Snapshot was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Snapshot.

Example: a8784665-3d99-5464-af32-30a2967f58e7

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Snapshot.

Example: /snapshots/a8784665-3d99-5464-af32-30a2967f58e7

propertiesobject · SnapshotRequired

A point in time snapshot of a In-Memory DB replica set.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get/snapshots/{snapshotId}

GET /snapshots/{snapshotId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "a8784665-3d99-5464-af32-30a2967f58e7",
  "type": "snapshot",
  "href": "/snapshots/a8784665-3d99-5464-af32-30a2967f58e7",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "replicasetId": "12345678-1234-1234-1234-123456789012",
    "snapshotTime": "2026-01-01T00:00:00.000Z",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "properties": {}
}