Create a MySQL database with a MySQL user

POST/v2/projects/{projectId}/mysql-databases/

API version

v2

Request method

POST

Operation ID

database-create-mysql-database

---

This operation creates a MySQL database and an associated MySQL user.

note

This operation is asynchronous. Even after a successful response, you will still need to wait until the database is successfully provisioned. Currently, the recommended way for that is to poll the GET/v2/mysql-databases/{mysqlDatabaseId}/ endpoint and observe the mainUser.status field in the response.

Both the database itself (.status) and the linked user (.mainUser.status) must have a status of ready to ensure a successful connection.

Request

• projectIdstring

  required

  ID of the Project to create a MySQLDatabase for.

Responses

Format

application/json

Description

Created

Schema documentation

• idstring (uuid)

  required
• userIdstring (uuid)

  required

Example

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "userId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id",
    "userId"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"database":{"characterSettings":{"characterSet":"utf8mb4","collation":"utf8mb4_general_ci"},"description":"string","version":"8.4"},"user":{"accessLevel":"full","externalAccess":true,"password":"string"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/string/mysql-databases

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.database.createMysqlDatabase({
  "projectId": "string",
  "data": {
    "database": {
      "characterSettings": {
        "characterSet": "utf8mb4",
        "collation": "utf8mb4_general_ci"
      },
      "description": "string",
      "version": "8.4"
    },
    "user": {
      "accessLevel": "full",
      "externalAccess": true,
      "password": "string"
    }
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Database\CreateMysqlDatabase\CreateMysqlDatabaseRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Database\CreateMysqlDatabase\CreateMysqlDatabaseRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// CreateMysqlDatabaseRequestBody to learn how to construct a valid instance
$body = new CreateMysqlDatabaseRequestBody(/* TODO: ... */);

$request = (new CreateMysqlDatabaseRequest(
  projectId: "string",
  body: $body
));
$response = $client->database()->createMysqlDatabase($request);

var_dump($response->getBody();