Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Databases endpoints (Client API: web hosting)

11 FeatherPanel Client API: web hosting endpoints from user/webspaces/databases.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/webspaces/databases.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}/databases

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

GET/api/user/webspaces/{uuidShort}/databases/hosts

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-databases-hostsController: WebSpaceDatabaseController::hostsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/hosts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

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

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

Plugin events: featherpanel:webspace:database:create

DELETE/api/user/webspaces/{uuidShort}/databases/{databaseId}

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

Plugin events: featherpanel:webspace:database:delete

POST/api/user/webspaces/{uuidShort}/databases/{databaseId}/reset-password

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

POST/api/user/webspaces/{uuidShort}/databases/{databaseId}/dump

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-databases-dumpController: WebSpaceDatabaseController::dumproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
databaseIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/$DATABASE_ID/dump" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/databases/{databaseId}/restore

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-databases-restoreController: WebSpaceDatabaseController::restoreDumproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
databaseIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/$DATABASE_ID/restore" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/databases/phpmyadmin/check

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-databases-phpmyadmin-checkController: WebSpaceDatabaseController::checkPhpMyAdminInstalledroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/phpmyadmin/check" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/databases/{databaseId}/phpmyadmin/token

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-databases-phpmyadmin-tokenController: WebSpaceDatabaseController::generatePhpMyAdminTokenroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
databaseIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/$DATABASE_ID/phpmyadmin/token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/databases/phppgadmin/check

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-databases-phppgadmin-checkController: WebSpaceDatabaseController::checkPhpPgAdminInstalledroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/phppgadmin/check" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/databases/{databaseId}/phppgadmin/token

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-databases-phppgadmin-tokenController: WebSpaceDatabaseController::generatePhpPgAdminTokenroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
databaseIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/databases/$DATABASE_ID/phppgadmin/token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/user/webspaces/databases.php
View source on GitHubReport a problemLast updated