Skip to main content

SaveGuard

saveguard

Automatic restore point listing, comparison, restore, and enrollment requests.

List restore points

PUT
Authenticated

Lists SaveGuard restore points for a service or service instance.

Request URLhttps://api.creeper.host/saveguard/listarchives

The instance field is required when listing restore points for an instanced service; omit it for single-instance services.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"id": "mc",
"instance": "mc-59026a225dc14"
}

Response 200

{
"status": "success",
"message": "List archives call successful",
"archives": [
{
"name": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00",
"time": "2026-06-11T09:00:00.000000"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}

List restore point contents

PUT
Authenticated

Lists files contained in a SaveGuard restore point.

Request URLhttps://api.creeper.host/saveguard/listcontents

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00"
}

Response 200

{
"status": "success",
"message": "List contents call successful",
"contents": [
{
"path": "home/minecraft/world/level.dat",
"type": "file",
"size": 4421,
"mtime": "2026-06-11T09:00:00.000000"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}

Compare restore points

PUT
Authenticated

Compares two SaveGuard restore points and returns changed paths.

Request URLhttps://api.creeper.host/saveguard/diff

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00",
"archiveName2": "minecraft-mc-59026a225dc14-oob-2026-06-11T10:00:00"
}

Response 200

{
"status": "success",
"message": "Diff call successful",
"diff": [
{
"path": "home/minecraft/world/level.dat",
"changes": [
{
"type": "modified"
}
]
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}

Restore restore point

PUT
Authenticated

Restores a SaveGuard restore point.

Request URLhttps://api.creeper.host/saveguard/restore

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00"
}

Response 200

{
"status": "success",
"message": "Restored backup",
"endPoint": "aries-production-59c48bc84-hpqw4"
}

Opt in service

PUT
Authenticated

Adds a service or service instance path to SaveGuard protection.

Request URLhttps://api.creeper.host/saveguard/optin

SaveGuard is generally enabled automatically when a service becomes eligible; opt-in is only needed for explicit enrollment flows.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"id": "mc",
"instance": "mc-59026a225dc14"
}

Response 200

{
"status": "success",
"message": "Opted in successfully",
"path": "/home/minecraft/mc-instances/mc-59026a225dc14",
"endPoint": "aries-production-59c48bc84-hpqw4"
}

Opt out service

PUT
Authenticated

Removes a service or service instance path from SaveGuard protection.

Request URLhttps://api.creeper.host/saveguard/optout

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
"id": "mc",
"instance": "mc-59026a225dc14"
}

Response 200

{
"status": "success",
"message": "Opted out successfully",
"endPoint": "aries-production-59c48bc84-hpqw4"
}

Check enrollment

PUT
Authenticated

Checks whether SaveGuard is enabled on the server.

Request URLhttps://api.creeper.host/saveguard/isenrolled

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{}

Response 200

{
"status": "success",
"message": "Your service has been enrolled in SaveGuard",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
Wiki offerGet 10% off