Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Storage Destinations endpoints (Client API: account)

10 FeatherPanel Client API: account endpoints from user/storage-destinations.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 3faf369 on .

On this page

Defined in backend/app/routes/user/storage-destinations.php. Authentication used here: Signed-in user, Public. 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/storage-destinations

Auth: Signed-in userDefault rate limit: 60 / minute (user-storage-destinations)Route name: user-storage-destinationsController: StorageDestinationController::indexroute source
curl -X GET "$PANEL_URL/api/user/storage-destinations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/storage-destinations

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-write)Route name: user-storage-destination-createController: StorageDestinationController::createroute source
curl -X POST "$PANEL_URL/api/user/storage-destinations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/storage-destinations/{id}

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-write)Route name: user-storage-destination-updateController: StorageDestinationController::updateroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X PATCH "$PANEL_URL/api/user/storage-destinations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/storage-destinations/{id}

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-write)Route name: user-storage-destination-updateController: StorageDestinationController::updateroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X PUT "$PANEL_URL/api/user/storage-destinations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/storage-destinations/{id}

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-write)Route name: user-storage-destination-deleteController: StorageDestinationController::deleteroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X DELETE "$PANEL_URL/api/user/storage-destinations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/storage-destinations/{id}/test

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-test)Route name: user-storage-destination-testController: StorageDestinationController::testroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X POST "$PANEL_URL/api/user/storage-destinations/$ID/test" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/storage-destinations/oauth/{provider}/start

Auth: Signed-in userDefault rate limit: 10 / minute (user-storage-destination-write)Route name: user-storage-destination-oauth-startController: StorageOAuthController::startroute source
ParameterInTypeRequiredDescription
providerpath-yes
curl -X POST "$PANEL_URL/api/user/storage-destinations/oauth/$PROVIDER/start" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/storage-destinations/oauth/{provider}/callback

Auth: PublicDefault rate limit: 20 / minute (user-storage-destination-write)Route name: user-storage-destination-oauth-callbackController: AuthMiddleware::handleroute source
ParameterInTypeRequiredDescription
providerpath-yes
curl -X GET "$PANEL_URL/api/user/storage-destinations/oauth/$PROVIDER/callback" \
  -H "Accept: application/json"

GET/api/storage/backups/{uuid}/download

Auth: PublicDefault rate limit: 30 / minute (storage-backup-stream)Route name: storage-backup-streamController: BackupStreamController::downloadroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/storage/backups/$UUID/download" \
  -H "Accept: application/json"

PUT/api/storage/relay/{uuid}

Auth: PublicDefault rate limit: 600 / minute (storage-backup-relay)Route name: storage-backup-relayController: RelayUploadController::receiveroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X PUT "$PANEL_URL/api/storage/relay/$UUID" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/user/storage-destinations.php
View source on GitHubReport a problemLast updated