Schedules
Update schedule
Updates the specified schedule
POST
/api/client/servers/{server}/schedules/{schedule}Authorization
ClientToken AuthorizationBearer <token>
Client API key (generated at /account/api)
In: header
Path Parameters
server*string
Server identifier (short 8-character ID)
schedule*integer
Schedule 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-month 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/1" \ -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "name": "Hourly Hello", "minute": "0", "hour": "*", "day_of_month": "*", "day_of_week": "*"}'{
"object": "server_schedule",
"attributes": {
"id": 2,
"name": "Hourly Hello",
"cron": {
"day_of_week": "*",
"day_of_month": "*",
"month": "*",
"hour": "*",
"minute": "0"
},
"is_active": false,
"is_processing": false,
"only_when_online": false,
"last_run_at": null,
"next_run_at": "2020-06-13T16:00:00+01:00",
"created_at": "2020-06-13T15:05:25+01:00",
"updated_at": "2020-06-13T15:14:07+01:00",
"relationships": {
"tasks": {
"object": "list",
"data": []
}
}
}
}