Delete a backup

DELETE

/backups/{backupId}

const url = 'https://example.com/api/v1/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'DELETE',
  headers: {cookie: '__Host-shardkeep_session=<__Host-shardkeep_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Needs backups.create; audited. A Node holding or able to reach it deletes the stored copy first.

Authorizations

sessionCookie
bearerToken

Parameters

Path Parameters

backupId

required

string format: uuid

Responses

204

Backup deleted.

401

Not signed in, or the credentials are invalid.

application/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

Signed in, but not allowed.

application/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

Not found, or not visible to you.

application/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

Clashes with existing data or state.

application/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"
}

503

The server’s Node is not connected, or did not answer in time (node_unavailable).

application/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.