Databases endpoints (Client API: game servers)

GET/api/user/servers/{uuidShort}/databases

Get server databases Retrieve all databases for a specific server that the user owns or has subuser access to, with pagination and search functionality.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/databases" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Server databases retrieved successfully · 400 Bad request - Missing or invalid UUID short · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to retrieve databases

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

Create database Create a new database for a server. Checks database limits and creates database on the specified host.

Request body: DatabaseCreateRequest (application/json) · Response data: DatabaseCreateResponse

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/databases" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"database_host_id":0,"database_name":"","remote":"","max_connections":0}'

Plugin events: featherpanel:user:server:database:created

Responses: 200 Database created successfully · 400 Bad request - Missing UUID, database limit reached, or invalid request body · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or database host not found · 500 Internal server error - Failed to create database

DELETE/api/user/servers/{uuidShort}/databases/bulk-delete

Bulk delete server databases Delete multiple databases at once. Pass an array of database IDs, or set all=true to delete every database for the server.

curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/bulk-delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"ids":[],"all":false}'

Plugin events: featherpanel:user:server:database:deleted

Responses: 200 Bulk delete completed · 400 Bad request - Invalid or missing parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or node not found · 500 Internal server error

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

Get available database hosts Retrieve all available database hosts that can be used for creating databases.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/hosts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Database hosts retrieved successfully · 400 Bad request - Missing or invalid UUID short · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to retrieve database hosts

GET/api/user/servers/{uuidShort}/databases/{databaseId}

Get specific database Retrieve details of a specific database for a server that the user owns or has subuser access to.

Response data: ServerDatabase

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Database details retrieved successfully · 400 Bad request - Missing or invalid parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or database not found · 500 Internal server error - Failed to retrieve database

PATCH/api/user/servers/{uuidShort}/databases/{databaseId}

Update database Update database settings including remote access pattern and maximum connections.

Request body: DatabaseUpdateRequest (application/json)

curl -X PATCH "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"remote":"","max_connections":0}'

Plugin events: featherpanel:user:server:database:updated

Responses: 200 Database updated successfully · 400 Bad request - Missing parameters or invalid request body · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or database not found · 500 Internal server error - Failed to update database

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

Delete database Permanently delete a database from a server. This action cannot be undone.

curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:server:database:deleted

Responses: 200 Database deleted successfully · 400 Bad request - Missing parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server, database, or database host not found · 500 Internal server error - Failed to delete database

POST/api/user/servers/{uuidShort}/databases/hosts/{databaseHostId}/test

Test database host connection Test the connection to a specific database host to verify connectivity and performance.

Response data: ConnectionTestResponse

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/hosts/$DATABASE_HOST_ID/test" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Connection test completed · 400 Bad request - Missing or invalid parameters · 401 Unauthorized - User not authenticated · 404 Not found - Server or database host not found · 500 Internal server error - Failed to test connection

GET/api/user/servers/{uuidShort}/databases/{databaseId}/export

Export database as SQL dump Generate a SQL dump of the database including CREATE TABLE statements and INSERT data. Requires database.view_password permission. Only supported for MySQL/MariaDB databases.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID/export" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 SQL dump generated successfully · 400 Bad request - Unsupported database type · 401 Unauthorized · 403 Forbidden - Requires database.view_password permission · 404 Server or database not found · 500 Internal server error - Failed to generate dump

POST/api/user/servers/{uuidShort}/databases/{databaseId}/import

Import SQL dump into database Execute a SQL dump against the database. Requires database.view_password permission. Statements are executed sequentially; execution stops on the first error by default.

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID/import" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"sql":"","ignore_errors":false}'

Responses: 200 SQL import completed · 400 Bad request - Missing SQL or unsupported database type · 401 Unauthorized · 403 Forbidden - Requires database.view_password permission · 404 Server or database not found · 500 Internal server error

POST/api/user/servers/{uuidShort}/databases/{databaseId}/query

Run a SQL query Execute a SQL query against the database and return results. Requires database.view_password permission. SELECT queries return rows (max 500); DML queries return affected row count.

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID/query" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"query":""}'

Responses: 200 Query executed successfully · 400 Bad request - Missing or empty query · 401 Unauthorized · 403 Forbidden - Requires database.view_password permission · 404 Server or database not found · 422 Query execution error · 500 Internal server error

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

Check phpMyAdmin installation Check if phpMyAdmin module is installed and available.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/phpmyadmin/check" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 phpMyAdmin installation status

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

Generate phpMyAdmin signon token Mint a single-use phpMyAdmin signon token (credentials stay server-side; URL carries only the opaque token).

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/databases/$DATABASE_ID/phpmyadmin/token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Token generated successfully · 400 Bad request - Missing parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server, database, or phpMyAdmin not found