Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Datenbanken

Derzeit unterstützen wir zwei Arten von Datenbanken: MySQL und MariaDB in verschiedenen Versionen.


GET /databases

Liefert eine Liste von Datenbanken für den aktuellen Kunden.

Mögliche Filter:

  • package_id: Pakete
  • server: Der Datenbankserver auf dem die Datenbank liegt (z.B. db22).
  • db_type: Der Datenbanktyp. Derzeit mysql oder mariadb.
  • version: Die Version der Datenbank (z.B. 8.0).

GET /databases/{id}

Liefert Details zur Datenbank mit der ID {id}.

Anlegen

Datenbanken werden stets auf dem aktuellen Standardserver für die jeweilige Datenbankversion angelegt. Es ist nicht möglich die API zum Anlegen von Datenbanken auf Datenbankservern zu nutzen, die auf einem dedizierten Server laufen.

POST /databases

Derzeit können folgende Kombinationen von Datenbank und Version angelegt werden. Es werden die gleichen Datenbanken und Versionen wie im Kundenmenü unterstützt.

Jede Datenbank ist einem Paket zugeordnet.

Um einen MariaDB 10.5 Datenbank im Paket mit der ID 42 und der Beschreibung “Eine freiwillige Beschreibung.” anzulegen, benutzen Sie folgenden POST-Body:

{
  "data": {
    "type": "database",
    "attributes": {
      "package_id": "42",
      "db_type": "mariadb",
      "version": "10.11",
      "description": "Eine freiwillige Beschreibung."
    }
  }
}

Ein sicheres Passwort wird für Sie automatisch erstellt und mit der Bestätigung – zusammen mit dem Server, auf dem die Datenbank angelegt wurde und der Datenbank-ID – zurückgegeben.

Manipulation

PATCH /databases/{id}

Erlaubt die Manipulation von existierenden Datenbanken. Bitte beachten Sie, dass die ID in der URL und das id-Feld im Body identisch sein müssen.

Beschreibung

{
  "data": {
    "type": "database",
    "id": "42",
    "attributes": {
      "description": "Wirklich freiwillig!"
    }
  }
}

Ändert die Beschreibung der Datenbank. Es ist möglich null als Beschreibung zu übergeben was gleichwertig mit einem leeren String ist.

Passwort

POST /databases/{id}/password

Generiert ein neues Passwort für die Datenbank mit der ID {id} und gibt es im Response-Body zurück.

Löschen

DELETE /databases/{id}

Löscht die Datenbank mit der ID {id}.