Create and manage server databases

Many plugins and mods keep their data in a MySQL database: permissions, economy balances, player statistics. The Databases tab creates MariaDB databases for your server, which work with any plugin that asks for MySQL. We create each one on a shared MariaDB host in the server's region.

• Your plan sets how many databases the server can have. The Databases card shows how many slots you have used, and Server settings shows the plan's Database slots.
• Free servers do not include databases. See How free servers work.
• On a server someone shared with you, the owner must have given you the Databases permission.

1. In the dashboard, go to Container Apps and open the server, then the Databases tab.
2. Select New database….
3. Enter a Name suffix that says what the database is for, such as stats or luckperms. Use lowercase letters, digits and underscores, up to 48 characters.
4. Leave Database host as it is. We always use the host in the server's region, whatever it says.
5. Select Create database.

The database's name is srv_, your server's number, an underscore and your suffix, such as srv_1234_stats. We create a user for it with a random 24-character password.

1. Select the database's name, or open the menu at the end of its row and select Show credentials.
2. Copy the values into your plugin's configuration file. Select Reveal to see the password, or Copy all to copy every value at once.
3. Restart the server so the plugin connects.

Host

The address of the database server. Use this value rather than the Host column in the list.

Port

Usually 3306.

Database

The database's name, such as srv_1234_stats.

Username and Password

The database user. You can show the password again at any time.

Connection URI

The same details in one mysql:// address, for plugins that ask for a URL. It includes the password.

JDBC

The same details as a jdbc:mysql:// address, for Java plugins that ask for one. It includes the password.

Rotate the password when you think someone else has seen it.

1. Open the menu at the end of the database's row and select Rotate password….
2. Select Rotate password.
3. Copy the new password from the window that opens, and put it in every plugin that uses the database.

1. Open the menu at the end of the database's row and select Delete database….
2. Type the database's name to confirm, then select Delete database.

We delete the database and every table in it, and you cannot undo it. A snapshot holds the server's files, not its databases, so export anything you want to keep first with a plugin or a MySQL client.

A new database shows in the list with its user under the name, and its credentials open straight away. The Status column shows each database's state, and a message confirms each action, such as Database created. or Database deleted.

The status shows a failure and Try again

We could not finish creating, rotating or deleting the database. The error shows under its name. We keep trying on our own, and Try again tries at once. If it keeps failing, contact support with the error.

New database… is greyed out

Every database slot is in use. Delete a database you no longer need, or move to a plan with more slots. See Change a service's plan.

Database limit reached (3/3)

The same limit, reached through the API or another tab. The numbers are your database count and your plan's limit.

A database named srv_1234_stats already exists on this host

The server already has a database with that suffix. Choose another suffix.

The database host is unreachable. We will keep trying; you can also retry from the list.

The database host did not answer. We keep trying, and the database finishes when the host is back. Select Try again to retry sooner.

No database host on this server's node

Databases are not available where your server runs. Contact support.

Retry the failed create before rotating the password

The database was never created. Select Try again first, then rotate the password.

Too many requests for this action. Please wait and try again.

You created more than 24 databases on this server in 60 seconds. Wait a minute and try again.

• Manage server files to edit the plugin's configuration file.
• Share a server with other users explains the Databases permission.
• Server limits and rate limits

Create a database with POST /api/v1/client/servers/{uuid}/databases. The body takes name_suffix (lowercase letters, digits and _, up to 48 characters) and remote, a MariaDB host pattern for where the user may connect from. remote defaults to %, which allows any address. We choose the database host, so any database_host_id you send is ignored.

curl -X POST https://api.coritan.com/api/v1/client/servers/$SERVER/databases \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-stats-db-1" \
  -d '{"name_suffix": "stats"}'

The response (201) carries id, name, username, password, host, port, uri, jdbc and status. With an Idempotency-Key header, sending the same request again returns the same database instead of a second one. See Idempotency.

The other routes use the database's id:

Each database has a status: ready, provisioning while we create it, rotating, deleting, or failed. busy is true during the three in-between states, and last_error holds the reason for a failure. Errors carry an error code and a message: database_limit_reached, database_name_taken, database_busy and database_not_ready answer 409, and database_host_unreachable answers 503.

On a server shared with you, listing needs database.read, creating and retrying need database.create, rotating needs database.update, reading the password needs database.view_password and deleting needs database.delete. The Databases permission in the dashboard grants all five.