Skip to content
Shardkeep

Restore a backup in place

POST
/servers/{serverId}/restore
curl --request POST \
  --url https://example.com/api/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/restore \
  --header 'Content-Type: application/json' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session> \
  --data '{ "backupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "safetyBackup": true }'

Needs backups.restore; audited. The server goes into RESTORING: its Node takes a safety backup first (unless safetyBackup is false), stops it, replaces its data (keeping its software and plugins) and starts it again if it should run. A backup made with newer Minecraft than the server runs is refused (backup_newer_software).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
serverId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
backupId
required
string format: uuid
safetyBackup

Back the server up first, to the backup’s destination.

boolean
default: true

Responses

Section titled “Responses”

202

Section titled “202”

The restore, under way.

Media typeapplication/json
object
id
required
string format: uuid
kind
required
string
Allowed values: RESTORE RESTORE_AS_NEW MIGRATE CLONE
serverId
required
string format: uuid
backupId
string format: uuid
sourceServerId
string format: uuid
fromNodeId
string format: uuid
toNodeId
string format: uuid
state
required
string
Allowed values: RUNNING SUCCEEDED FAILED
error
string
createdAt
required
string format: date-time
Example
{
  "kind": "RESTORE",
  "state": "RUNNING"
}

400

Section titled “400”

The request is invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
code
required

Stable machine-readable error code.

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

401

Section titled “401”

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
code
required

Stable machine-readable error code.

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

403

Section titled “403”

Signed in, but not allowed.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
code
required

Stable machine-readable error code.

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

404

Section titled “404”

Not found, or not visible to you.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
code
required

Stable machine-readable error code.

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

409

Section titled “409”

Clashes with existing data or state.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
code
required

Stable machine-readable error code.

string
Example
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

Shardkeep is free software under the AGPL-3.0. Minecraft is a trademark of Mojang AB; Shardkeep is not affiliated with or endorsed by Mojang or Microsoft.