Schedules endpoints (Client API: web hosting)

8 FeatherPanel Client API: web hosting endpoints from user/webspaces/schedules.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on 23 Oct 2026.

On this page

Defined in backend/app/routes/user/webspaces/schedules.php. Authentication used here: Signed-in user. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET`/api/user/webspaces/{uuidShort}/schedules`

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-schedulesController: WebSpaceScheduleController::indexroute source

List WebSpace schedules

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes

curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST`/api/user/webspaces/{uuidShort}/schedules`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-createController: WebSpaceScheduleController::createroute source

Create WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes

curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:schedule:create

POST`/api/user/webspaces/{uuidShort}/schedules/abort`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-abortController: WebSpaceScheduleController::abortroute source

Abort WebSpace schedule run

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes

curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/abort" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET`/api/user/webspaces/{uuidShort}/schedules/{scheduleId}`

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-schedules-showController: WebSpaceScheduleController::showroute source

Get WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes
`scheduleId`	path	-	yes

curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT`/api/user/webspaces/{uuidShort}/schedules/{scheduleId}`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-updateController: WebSpaceScheduleController::updateroute source

Update WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes
`scheduleId`	path	-	yes

curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:schedule:update

DELETE`/api/user/webspaces/{uuidShort}/schedules/{scheduleId}`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-deleteController: WebSpaceScheduleController::deleteroute source

Delete WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes
`scheduleId`	path	-	yes

curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:schedule:delete

POST`/api/user/webspaces/{uuidShort}/schedules/{scheduleId}/toggle`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-toggleController: WebSpaceScheduleController::toggleroute source

Toggle WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes
`scheduleId`	path	-	yes

curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/$SCHEDULE_ID/toggle" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST`/api/user/webspaces/{uuidShort}/schedules/{scheduleId}/execute`

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-schedules-executeController: WebSpaceScheduleController::executeroute source

Execute WebSpace schedule

Parameter	In	Type	Required	Description
`uuidShort`	path	-	yes
`scheduleId`	path	-	yes

curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/schedules/$SCHEDULE_ID/execute" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Schedules endpoints (Client API: web hosting)

Endpoints

GET/api/user/webspaces/{uuidShort}/schedules

POST/api/user/webspaces/{uuidShort}/schedules

POST/api/user/webspaces/{uuidShort}/schedules/abort

GET/api/user/webspaces/{uuidShort}/schedules/{scheduleId}

PUT/api/user/webspaces/{uuidShort}/schedules/{scheduleId}

DELETE/api/user/webspaces/{uuidShort}/schedules/{scheduleId}

POST/api/user/webspaces/{uuidShort}/schedules/{scheduleId}/toggle

POST/api/user/webspaces/{uuidShort}/schedules/{scheduleId}/execute