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

metadataobject · NoMetadataRead-onlyRequired

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 /v2/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": {},
  "properties": {
    "clusterId": "59348c25-2d4b-4870-a5b6-33c48fce1c58",
    "clusterName": "my-in-memory-db-cluster",
    "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
    "earliestRecoveryTargetTime": "2023-10-05T14:48:00.000Z",
    "latestRecoveryTargetTime": "2023-10-10T14:48:00.000Z",
    "location": "eu-central-3",
    "clusterVersion": "9.0",
    "snapshotSize": 16,
    "requiredSizeForRestore": 16
  }
}