Restore

Status endpoints for requested restores.

This tag groups all operations for restore.

Retrieve all Restore

get

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/snapshots/{snapshotId}/restores

This endpoint enables retrieving all Restore using pagination and optional filters.

Authorizations

tokenAuth

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

Query parameters

offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use this parameter together with the limit for pagination.

Default: 0Example: 0

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use this parameter together with the offset for pagination.

Default: 100Example: 100

filter.namestringOptional

Response filter to list only items contain the specified name. The value is case insensitive and matched on the 'displayName' field.

Responses

200

Returned all requested Restore successfully.

application/json

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of Restore resources.

Example: 5348fe6c-5e4a-5ff3-aa3c-d5232987f9d5

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of Restore resources.

Example: /snapshots/{snapshotId}/restores

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

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

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}/restores

HTTPcURLJavaScriptPython

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

{
  "id": "5348fe6c-5e4a-5ff3-aa3c-d5232987f9d5",
  "type": "collection",
  "href": "/snapshots/{snapshotId}/restores",
  "items": [
    {
      "id": "39fe1580-552b-5182-8939-a3ac6c38f94c",
      "type": "restore",
      "href": "/snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c",
      "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.",
        "restoreTime": "2026-04-04T08:02:29.466Z",
        "restoredSnapshotId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "properties": {
        "replicasetId": "123e4567-e89b-12d3-a456-426614174000",
        "displayName": "In-Memory DB snapshot",
        "description": "Snapshot of the In-Memory DB replica set."
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create Restore

post

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/snapshots/{snapshotId}/restores

Creates a new Restore.

The full Restore needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations

tokenAuth

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

Body

application/json

metadataanyOptional

Metadata

Responses

201

Restore successfully created.

application/json

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

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

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

post

/snapshots/{snapshotId}/restores

HTTPcURLJavaScriptPython

POST /snapshots/{snapshotId}/restores HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "metadata": {},
  "properties": {
    "replicasetId": "123e4567-e89b-12d3-a456-426614174000",
    "displayName": "In-Memory DB snapshot",
    "description": "Snapshot of the In-Memory DB replica set."
  }
}

{
  "id": "39fe1580-552b-5182-8939-a3ac6c38f94c",
  "type": "restore",
  "href": "/snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c",
  "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.",
    "restoreTime": "2026-04-04T08:02:29.466Z",
    "restoredSnapshotId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "properties": {
    "replicasetId": "123e4567-e89b-12d3-a456-426614174000",
    "displayName": "In-Memory DB snapshot",
    "description": "Snapshot of the In-Memory DB replica set."
  }
}

Retrieve Restore

get

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/snapshots/{snapshotId}/restores/{restoreId}

Returns the Restore by ID.

Authorizations

tokenAuth

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

restoreIdstring · uuidRequired

The ID (UUID) of the Restore.

Example: 39fe1580-552b-5182-8939-a3ac6c38f94c

Responses

200

Getting Restore was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Restore.

Example: 39fe1580-552b-5182-8939-a3ac6c38f94c

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Restore.

Example: /snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c

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}/restores/{restoreId}

HTTPcURLJavaScriptPython

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

{
  "id": "39fe1580-552b-5182-8939-a3ac6c38f94c",
  "type": "restore",
  "href": "/snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c",
  "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.",
    "restoreTime": "2026-04-04T08:02:29.466Z",
    "restoredSnapshotId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "properties": {
    "replicasetId": "123e4567-e89b-12d3-a456-426614174000",
    "displayName": "In-Memory DB snapshot",
    "description": "Snapshot of the In-Memory DB replica set."
  }
}