List MySQL databases belonging to a Project

GET/projects/{projectId}/mysql-databases/

API version

v2

Request method

GET

Operation ID

database-list-mysql-databases

---

Request

• projectIdstring (uuid)

  required

  ID of the Project to list MySQLDatabases for.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • characterSettingsobject

    required
    • characterSetstring

      required

      A valid MySQL character set

    • collationstring

      required

      A valid MySQL collation

  • createdAtstring (date-time)

    required
  • descriptionstring

    required
  • externalHostnamestring

    required
  • finalizersarray of string (≥ 1 characters)
    • Array[
    • *string (≥ 1 characters)
    ]
• hostnamestring

  required
• idstring (uuid)

  required
• isReadyboolean

  required
• isSharedboolean

  required
• namestring

  required
• projectIdstring (uuid)

  required
• statusstring (one of: pending, ready, migrating, importing, error)

  required
• statusSetAtstring (date-time)

  required
• storageUsageInBytesinteger

  required
• storageUsageInBytesSetAtstring (date-time)

  required
• updatedAtstring (date-time)

  required
• versionstring

  required

]

Example

[
  {
    "characterSettings": {
      "characterSet": "utf8mb4",
      "collation": "utf8mb4_general_ci"
    },
    "createdAt": "2024-12-21T00:27:30.577Z",
    "description": "string",
    "externalHostname": "string",
    "finalizers": [
      "string"
    ],
    "hostname": "string",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "isReady": true,
    "isShared": true,
    "name": "string",
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "status": "pending",
    "statusSetAt": "2024-12-21T00:27:30.577Z",
    "storageUsageInBytes": 123,
    "storageUsageInBytesSetAt": "2024-12-21T00:27:30.577Z",
    "updatedAt": "2024-12-21T00:27:30.577Z",
    "version": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "characterSettings": {
        "properties": {
          "characterSet": {
            "type": "string",
            "description": "A valid MySQL character set",
            "example": "utf8mb4"
          },
          "collation": {
            "type": "string",
            "description": "A valid MySQL collation",
            "example": "utf8mb4_general_ci"
          }
        },
        "required": [
          "characterSet",
          "collation"
        ],
        "type": "object"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "externalHostname": {
        "type": "string"
      },
      "finalizers": {
        "items": {
          "minLength": 1,
          "type": "string"
        },
        "type": "array",
        "uniqueItems": true
      },
      "hostname": {
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "isReady": {
        "type": "boolean"
      },
      "isShared": {
        "type": "boolean"
      },
      "name": {
        "type": "string"
      },
      "projectId": {
        "format": "uuid",
        "type": "string"
      },
      "status": {
        "enum": [
          "pending",
          "ready",
          "migrating",
          "importing",
          "error"
        ],
        "type": "string"
      },
      "statusSetAt": {
        "format": "date-time",
        "type": "string"
      },
      "storageUsageInBytes": {
        "type": "integer"
      },
      "storageUsageInBytesSetAt": {
        "format": "date-time",
        "type": "string"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      },
      "version": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "createdAt",
      "updatedAt",
      "projectId",
      "name",
      "description",
      "version",
      "characterSettings",
      "hostname",
      "isShared",
      "isReady",
      "storageUsageInBytes",
      "storageUsageInBytesSetAt",
      "status",
      "statusSetAt",
      "externalHostname"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/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.listMysqlDatabases({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListMysqlDatabasesRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->database()->listMysqlDatabases($request);

var_dump($response->getBody();