Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

SFTP Accounts endpoints (Client API: web hosting)

5 FeatherPanel Client API: web hosting endpoints from user/webspaces/sftp-accounts.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/user/webspaces/sftp-accounts.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}/sftp-accounts

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-sftp-accountsController: WebSpaceSftpAccountController::indexroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/sftp-accounts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/sftp-accounts

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-sftp-accounts-createController: WebSpaceSftpAccountController::createroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/sftp-accounts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:sftp:account:created

PATCH/api/user/webspaces/{uuidShort}/sftp-accounts/{accountId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-sftp-accounts-updateController: WebSpaceSftpAccountController::updateroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
accountIdpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT/sftp-accounts/$ACCOUNT_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:sftp:account:updated

DELETE/api/user/webspaces/{uuidShort}/sftp-accounts/{accountId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-sftp-accounts-deleteController: WebSpaceSftpAccountController::deleteroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
accountIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/sftp-accounts/$ACCOUNT_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:sftp:account:deleted

POST/api/user/webspaces/{uuidShort}/sftp-accounts/{accountId}/reset-password

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-sftp-accounts-reset-passwordController: WebSpaceSftpAccountController::resetPasswordroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
accountIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/sftp-accounts/$ACCOUNT_ID/reset-password" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:sftp:password:reset

Written from the source:FeatherPanel/backend/app/routes/user/webspaces/sftp-accounts.php
View source on GitHubReport a problemLast updated