API docs by Redocly

In-Memory DB API (1.0.0)

Download OpenAPI specification:Download

IONOS Cloud Support: support@cloud.ionos.com URL: https://docs.ionos.com/support/general-information/contact-information

API description for the IONOS In-Memory DB

IONOS Cloud - API documentation

ReplicaSet

In-Memory DB replica set with support for a single instance or a In-Memory DB replication in leader follower mode. The mode is determined by the number of replicas. One replica is standalone, everything else an In-Memory DB replication as leader follower mode with one active and n-1 passive replicas.

This tag groups all operations for replicaset.

Retrieve all ReplicaSet

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

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

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

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

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

filter.name
string

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

Responses

Response samples

Content type
application/json
{
  • "id": "2ec26f24-9fca-5576-8cda-03d6a0156bbc",
  • "type": "collection",
  • "href": "/replicasets",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create ReplicaSet

Creates a new ReplicaSet.

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

Authorizations:
tokenAuth
Request Body schema: application/json

ReplicaSet to create.

object

Metadata

required
object (ReplicaSet)

Properties with all data needed to create a new In-Memory DB replication.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "type": "replicaset",
  • "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve ReplicaSet

Returns the ReplicaSet by ID.

Authorizations:
tokenAuth
path Parameters
replicasetId
required
string <uuid>
Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9

The ID (UUID) of the ReplicaSet.

Responses

Response samples

Content type
application/json
{
  • "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "type": "replicaset",
  • "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure ReplicaSet

Ensures that the ReplicaSet with the provided ID is created or modified. The full ReplicaSet needs to be provided to ensure (either update or create) the ReplicaSet. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
replicasetId
required
string <uuid>
Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9

The ID (UUID) of the ReplicaSet.

Request Body schema: application/json

update ReplicaSet

id
required
string <uuid>

The ID (UUID) of the ReplicaSet.

object

Metadata

required
object (ReplicaSet)

Properties with all data needed to create a new In-Memory DB replication.

Responses

Request samples

Content type
application/json
{
  • "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "type": "replicaset",
  • "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete ReplicaSet

Deletes the specified ReplicaSet.

Authorizations:
tokenAuth
path Parameters
replicasetId
required
string <uuid>
Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9

The ID (UUID) of the ReplicaSet.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Snapshot

Operations to create and manage point in time snapshots for your In-Memory DB replica sets.

This tag groups all operations for snapshot.

Retrieve all Snapshot

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

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

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

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

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

Responses

Response samples

Content type
application/json
{
  • "id": "b9cb6c65-8997-58bb-b7d1-93e5da5a6525",
  • "type": "collection",
  • "href": "/snapshots",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Retrieve Snapshot

Returns the Snapshot by ID.

Authorizations:
tokenAuth
path Parameters
snapshotId
required
string <uuid>
Example: a8784665-3d99-5464-af32-30a2967f58e7

The ID (UUID) of the Snapshot.

Responses

Response samples

Content type
application/json
{
  • "id": "a8784665-3d99-5464-af32-30a2967f58e7",
  • "type": "snapshot",
  • "href": "/snapshots/a8784665-3d99-5464-af32-30a2967f58e7",
  • "metadata": {
    },
  • "properties": { }
}

Restore

Status endpoints for requested restores.

This tag groups all operations for restore.

Retrieve all Restore

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

Authorizations:
tokenAuth
path Parameters
snapshotId
required
string <uuid>
Example: a8784665-3d99-5464-af32-30a2967f58e7

The ID (UUID) of the Snapshot.

query Parameters
offset
integer <int32> >= 0
Default: 0

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

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

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

filter.name
string

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

Responses

Response samples

Content type
application/json
{
  • "id": "5348fe6c-5e4a-5ff3-aa3c-d5232987f9d5",
  • "type": "collection",
  • "href": "/snapshots/{snapshotId}/restores",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Restore

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
path Parameters
snapshotId
required
string <uuid>
Example: a8784665-3d99-5464-af32-30a2967f58e7

The ID (UUID) of the Snapshot.

Request Body schema: application/json

Restore to create.

object

Metadata

required
object (Restore)

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

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "39fe1580-552b-5182-8939-a3ac6c38f94c",
  • "type": "restore",
  • "href": "/snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Restore

Returns the Restore by ID.

Authorizations:
tokenAuth
path Parameters
snapshotId
required
string <uuid>
Example: a8784665-3d99-5464-af32-30a2967f58e7

The ID (UUID) of the Snapshot.

restoreId
required
string <uuid>
Example: 39fe1580-552b-5182-8939-a3ac6c38f94c

The ID (UUID) of the Restore.

Responses

Response samples

Content type
application/json
{
  • "id": "39fe1580-552b-5182-8939-a3ac6c38f94c",
  • "type": "restore",
  • "href": "/snapshots/{snapshotId}/restores/39fe1580-552b-5182-8939-a3ac6c38f94c",
  • "metadata": {
    },
  • "properties": {
    }
}