Create schedule

Creates a new schedule

POST/api/client/servers/{server}/schedules

Authorization

ClientToken

AuthorizationBearer <token>

Client API key (generated at /account/api)

In: header

Path Parameters

server*string

Server identifier (short 8-character ID)

Request Body

application/json

name*string

Friendly name for the schedule

is_active?boolean

Specifies whether the schedule is active

minute*string

Cron minute syntax

hour*string

Cron hour syntax

day_of_week*string

Cron day-of-week syntax

day_of_month*string

Cron day-of-month syntax

month?string

Cron month field; defaults to *

only_when_online?boolean

Response Body

`application/json`

curl -X POST "https://pterodactyl.file.properties/api/client/servers/1a7ce997/schedules" \  -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{  "name": "Minute Hello",  "minute": "*",  "hour": "*",  "day_of_month": "*",  "day_of_week": "*",  "is_active": true}'

{
  "object": "server_schedule",
  "attributes": {
    "id": 4,
    "name": "Minute Hello",
    "cron": {
      "day_of_week": "*",
      "day_of_month": "*",
      "month": "*",
      "hour": "*",
      "minute": "*"
    },
    "is_active": true,
    "is_processing": false,
    "only_when_online": false,
    "last_run_at": null,
    "next_run_at": "2020-06-13T15:17:00+01:00",
    "created_at": "2020-06-13T15:16:45+01:00",
    "updated_at": "2020-06-13T15:16:45+01:00",
    "relationships": {
      "tasks": {
        "object": "list",
        "data": []
      }
    }
  }
}