Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xyrapanel/panel/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Database hosts are MySQL/MariaDB servers that can create databases for game servers. Each host can have a maximum database limit and be assigned to specific nodes.

​
Endpoints

​
List Database Hosts

curl -X GET "https://panel.example.com/api/admin/database-hosts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Authentication: Admin with database_hosts:read permission Response: 
{
  "data": [
    {
      "id": "host-uuid",
      "name": "MySQL Server 1",
      "hostname": "mysql.example.com",
      "port": 3306,
      "username": "pterodactyl",
      "maxDatabases": 100,
      "databaseCount": 42
    }
  ]
}

​
Create Database Host

curl -X POST "https://panel.example.com/api/admin/database-hosts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MySQL Server 2",
    "hostname": "mysql2.example.com",
    "port": 3306,
    "username": "pterodactyl",
    "password": "secure_password",
    "database": "panel",
    "nodeId": "node-uuid",
    "maxDatabases": 200
  }'
Request Body:
  • name (required): Display name (1-255 characters, trimmed)
  • hostname (required): MySQL hostname or IP (1-255 characters, trimmed)
  • port (optional): MySQL port (1-65535, default: 3306)
  • username (required): MySQL username (1-255 characters, trimmed)
  • password (required): MySQL password (minimum 1 character)
  • database (optional): Database name to use for the panel (1-255 characters, trimmed)
  • nodeId (optional): Assign to specific node (UUID, trimmed)
  • maxDatabases (optional): Maximum databases allowed (minimum: 0, null = unlimited)

​
Update Database Host

curl -X PATCH "https://panel.example.com/api/admin/database-hosts/host-uuid" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "maxDatabases": 250
  }'
Request Body: Same as create, but all fields are optional

​
Delete Database Host

curl -X DELETE "https://panel.example.com/api/admin/database-hosts/host-uuid" \
  -H "Authorization: Bearer YOUR_API_KEY"
Restrictions: Cannot delete a host that has databases created on it

​
Test Database Connection

curl -X POST "https://panel.example.com/api/admin/database-hosts/host-uuid/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Tests the connection to the database host to verify credentials and connectivity. Response: 
{
  "data": {
    "success": true,
    "message": "Connection successful"
  }
}

​
Database Host Object

​
id
string
Database host UUID
​
name
string
Display name for the database host
​
hostname
string
MySQL server hostname or IP address
​
port
integer
MySQL server port
​
username
string
MySQL username
​
maxDatabases
integer
Maximum databases allowed (null = unlimited)
​
databaseCount
integer
Current number of databases on this host

​
Notes

  • Database hosts are ordered alphabetically by name
  • The databaseCount is computed via SQL join
  • Password is never returned in API responses
  • Use the test endpoint to verify connection before creating servers
  • The database host user needs privileges to create databases and users

​
Required MySQL Privileges

The database host user needs the following privileges: 
GRANT CREATE, DROP, ALTER, INDEX, REFERENCES ON *.* TO 'pterodactyl'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE USER ON *.* TO 'pterodactyl'@'%';

​
Security Considerations

  • Use strong passwords for database host accounts
  • Limit access by IP when possible
  • Consider using separate database hosts per node or region
  • Monitor databaseCount against maxDatabases limits

Build docs developers (and LLMs) love

Get started for freeTalk to us