Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Wings Backups endpoints (Admin API)

14 FeatherPanel Admin API endpoints from admin/wings-backups.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/wings-backups.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/wings-backups/destinations

Auth: AdminPermission: admin.wings_backups.viewRoute name: admin-wings-backups-destinationsroute source

List Wings backup destinations

curl -X GET "$PANEL_URL/api/admin/wings-backups/destinations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/wings-backups/destinations

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-destinations-createroute source

Create Wings backup destination

curl -X PUT "$PANEL_URL/api/admin/wings-backups/destinations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/admin/wings-backups/destinations/{id}

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-destinations-updateroute source

Update Wings backup destination

ParameterInTypeRequiredDescription
idpath-yes
curl -X PATCH "$PANEL_URL/api/admin/wings-backups/destinations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/admin/wings-backups/destinations/{id}

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-destinations-deleteroute source

Delete Wings backup destination

ParameterInTypeRequiredDescription
idpath-yes
curl -X DELETE "$PANEL_URL/api/admin/wings-backups/destinations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/admin/wings-backups/destinations/{id}/test

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-destinations-testroute source

Test Wings backup destination

ParameterInTypeRequiredDescription
idpath-yes
curl -X POST "$PANEL_URL/api/admin/wings-backups/destinations/$ID/test" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/admin/wings-backups/destinations/{id}/purge

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-destinations-purgeroute source

Purge old objects on destination

ParameterInTypeRequiredDescription
idpath-yes
curl -X POST "$PANEL_URL/api/admin/wings-backups/destinations/$ID/purge" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/wings-backups/policies

Auth: AdminPermission: admin.wings_backups.viewRoute name: admin-wings-backups-policiesroute source

List Wings backup policies

curl -X GET "$PANEL_URL/api/admin/wings-backups/policies" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/wings-backups/policies

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-policies-createroute source

Create Wings backup policy

curl -X PUT "$PANEL_URL/api/admin/wings-backups/policies" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/wings-backups/policies/{id}

Auth: AdminPermission: admin.wings_backups.viewRoute name: admin-wings-backups-policies-showroute source

Get Wings backup policy

ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/admin/wings-backups/policies/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/admin/wings-backups/policies/{id}

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-policies-updateroute source

Update Wings backup policy

ParameterInTypeRequiredDescription
idpath-yes
curl -X PATCH "$PANEL_URL/api/admin/wings-backups/policies/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/admin/wings-backups/policies/{id}

Auth: AdminPermission: admin.wings_backups.manageRoute name: admin-wings-backups-policies-deleteroute source

Delete Wings backup policy

ParameterInTypeRequiredDescription
idpath-yes
curl -X DELETE "$PANEL_URL/api/admin/wings-backups/policies/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/admin/wings-backups/policies/{id}/run

Auth: AdminPermission: admin.wings_backups.runRoute name: admin-wings-backups-policies-runroute source

Run Wings backup policy now

ParameterInTypeRequiredDescription
idpath-yes
curl -X POST "$PANEL_URL/api/admin/wings-backups/policies/$ID/run" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/wings-backups/policies/{id}/runs

Auth: AdminPermission: admin.wings_backups.viewRoute name: admin-wings-backups-policies-runsroute source

List Wings backup policy runs

ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/admin/wings-backups/policies/$ID/runs" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/wings-backups/policies/{id}/runs/{runId}

Auth: AdminPermission: admin.wings_backups.viewRoute name: admin-wings-backups-policies-run-showroute source

Show Wings backup run

ParameterInTypeRequiredDescription
idpath-yes
runIdpath-yes
curl -X GET "$PANEL_URL/api/admin/wings-backups/policies/$ID/runs/$RUN_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/admin/wings-backups.php
View source on GitHubReport a problemLast updated