Skip to content
Shardkeep

Add a schedule

POST
/servers/{serverId}/schedules
curl --request POST \
  --url https://example.com/api/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schedules \
  --header 'Content-Type: application/json' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session> \
  --data '{ "cron": "example", "timeZone": "UTC", "action": "BACKUP", "destinationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "keepLast": 7, "keepDays": 0, "command": "example", "enabled": true }'

Needs servers.update (and backups.create for a backup schedule); audited. The server’s Agent runs it, also while the Controller is down.

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
cron
required
string
>= 9 characters <= 200 characters
timeZone
string
default: UTC <= 64 characters
action
required
string
Allowed values: BACKUP RESTART COMMAND
destinationId
string format: uuid
keepLast
integer
default: 7 >= 1 <= 1000
keepDays
integer
0 <= 3650
command
string
<= 256 characters
enabled
boolean
default: true

Responses

Section titled “Responses”

201

Section titled “201”

Schedule added.

Media typeapplication/json
object
id
required
string format: uuid
cron
required

Five fields: minute hour day-of-month month day-of-week.

string
timeZone
required

An IANA time zone.

string
action
required
string
Allowed values: BACKUP RESTART COMMAND
destinationId
string format: uuid
keepLast
integer
keepDays
integer
command
string
enabled
required
boolean
nextRunAt

When it next runs (if enabled).

string format: date-time
Example
{
  "action": "BACKUP"
}

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

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.