Backup Schedules endpoints (Admin API)
10 FeatherPanel Admin API endpoints from admin/backup-schedules.php: methods, paths, auth, permissions, rate limits, parameters and responses.
Last synced from FeatherPanel 15b94e9 on .
On this page
Defined in backend/app/routes/admin/backup-schedules.php. Authentication used here: Admin. 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/admin/backup-schedules
List admin backup schedules
curl -X GET "$PANEL_URL/api/admin/backup-schedules" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 OK
GET/api/admin/backup-schedules/calendar
Backup schedule calendar Planned runs of active backup schedules and recorded runs for one month (month=YYYY-MM, UTC).
curl -X GET "$PANEL_URL/api/admin/backup-schedules/calendar" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Calendar retrieved
POST/api/admin/backup-schedules/preview-targets
Preview target servers for a backup schedule scope
curl -X POST "$PANEL_URL/api/admin/backup-schedules/preview-targets" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 OK
GET/api/admin/backup-schedules/{id}
Get admin backup schedule
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes |
curl -X GET "$PANEL_URL/api/admin/backup-schedules/$ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 OK
PUT/api/admin/backup-schedules
Create admin backup schedule
curl -X PUT "$PANEL_URL/api/admin/backup-schedules" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:backup_policy:created
Responses: 201 Created
PATCH/api/admin/backup-schedules/{id}
Update admin backup schedule
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes |
curl -X PATCH "$PANEL_URL/api/admin/backup-schedules/$ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:backup_policy:updated
Responses: 200 OK
DELETE/api/admin/backup-schedules/{id}
Delete admin backup schedule
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes |
curl -X DELETE "$PANEL_URL/api/admin/backup-schedules/$ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:backup_policy:deleted
Responses: 200 OK
POST/api/admin/backup-schedules/{id}/run
Run admin backup schedule now
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes |
curl -X POST "$PANEL_URL/api/admin/backup-schedules/$ID/run" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:backup_policy:run:completed, featherpanel:admin:backup_policy:run:started
Responses: 200 OK
GET/api/admin/backup-schedules/{id}/runs
List backup schedule runs
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes |
curl -X GET "$PANEL_URL/api/admin/backup-schedules/$ID/runs" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 OK
GET/api/admin/backup-schedules/{id}/runs/{runId}
Get backup schedule run details
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | - | yes | |
runId | path | - | yes |
curl -X GET "$PANEL_URL/api/admin/backup-schedules/$ID/runs/$RUN_ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 OK