Get a MySQL database

GET/mysql-databases/{mysqlDatabaseId}/

API version

v2

Request method

GET

Operation ID

database-get-mysql-database

---

Returns a MySQLDatabase resource and its current status. Note that establishing a connection requires the linked user to have a status of ready; relying solely on the database status is insufficient.

Request

• mysqlDatabaseIdstring

  required

  ID of the MySQLDatabase to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• 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
• mainUserobject
  • accessIpMaskstring
  • accessLevelstring (one of: full, readonly)

    required
  • createdAtstring (date-time)

    required
  • databaseIdstring (uuid)

    required
  • descriptionstring
  • disabledboolean

    required
  • externalAccessboolean

    required
  • idstring (uuid)

    required
  • mainUserboolean

    required
  • namestring

    required
  • passwordUpdatedAtstring (date-time)

    required
  • statusstring (one of: pending, ready, error, terminating, disabled)

    required
  • statusSetAtstring (date-time)

    required
  • updatedAtstring (date-time)

    required
• namestring

  required
• projectIdstring (uuid)

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

  required
• statusSetAtstring (date-time)

  required
• storageUsageInBytesinteger (int64)

  required
• storageUsageInBytesSetAtstring (date-time)

  required
• updatedAtstring (date-time)

  required
• versionstring

  required

Example

Content-Type: application/json

{
  "characterSettings": {
    "characterSet": "utf8mb4",
    "collation": "utf8mb4_general_ci"
  },
  "createdAt": "1985-10-26T01:21:00.000Z",
  "description": "string",
  "externalHostname": "string",
  "finalizers": [
    "string"
  ],
  "hostname": "string",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "isReady": true,
  "isShared": true,
  "mainUser": {
    "accessIpMask": "string",
    "accessLevel": "full",
    "createdAt": "1985-10-26T01:21:00.000Z",
    "databaseId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "description": "string",
    "disabled": true,
    "externalAccess": true,
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "mainUser": true,
    "name": "string",
    "passwordUpdatedAt": "1985-10-26T01:21:00.000Z",
    "status": "pending",
    "statusSetAt": "1985-10-26T01:21:00.000Z",
    "updatedAt": "1985-10-26T01:21:00.000Z"
  },
  "name": "string",
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "status": "pending",
  "statusSetAt": "1985-10-26T01:21:00.000Z",
  "storageUsageInBytes": 123,
  "storageUsageInBytesSetAt": "1985-10-26T01:21:00.000Z",
  "updatedAt": "1985-10-26T01:21:00.000Z",
  "version": "string"
}

JSON Schema

{
  "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"
    },
    "mainUser": {
      "properties": {
        "accessIpMask": {
          "type": "string"
        },
        "accessLevel": {
          "enum": [
            "full",
            "readonly"
          ],
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "databaseId": {
          "format": "uuid",
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "disabled": {
          "type": "boolean"
        },
        "externalAccess": {
          "type": "boolean"
        },
        "id": {
          "format": "uuid",
          "type": "string"
        },
        "mainUser": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "passwordUpdatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "enum": [
            "pending",
            "ready",
            "error",
            "terminating",
            "disabled"
          ],
          "type": "string"
        },
        "statusSetAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "createdAt",
        "updatedAt",
        "databaseId",
        "name",
        "passwordUpdatedAt",
        "mainUser",
        "disabled",
        "accessLevel",
        "externalAccess",
        "status",
        "statusSetAt"
      ],
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "projectId": {
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "pending",
        "ready",
        "migrating",
        "importing",
        "error"
      ],
      "type": "string"
    },
    "statusSetAt": {
      "format": "date-time",
      "type": "string"
    },
    "storageUsageInBytes": {
      "format": "int64",
      "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"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/mysql-databases/string

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.getMysqlDatabase({
  "mysqlDatabaseId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetMysqlDatabaseRequest(
  mysqlDatabaseId: "string"
));
$response = $client->database()->getMysqlDatabase($request);

var_dump($response->getBody();