List a server's schedules

GET

/servers/{serverId}/schedules

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

Needs servers.read.

Authorizations

• sessionCookie
• bearerToken

Parameters

Path Parameters

serverId

required

string format: uuid

Responses

200

Schedules, oldest first.

Media typeapplication/json

object

items

required

Array<object>

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

{
  "items": [
    {
      "action": "BACKUP"
    }
  ]
}

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

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