Zum Hauptinhalt springen

Ein Projekt über die API erstellen

Über Projekt-Platzierungen​

Es gibt verschiedene Möglichkeiten, ein neues Projekt zu erstellen:

  1. Wenn du Zugriff auf einen Server hast (zum Beispiel, wenn du den "Space Server"-Tarif1 verwendest), kannst du ein neues Projekt auf diesem Server erstellen. Alle Projekte, die auf einem Server erstellt werden, verwenden denselben gemeinsamen Ressourcen-Pool. Da du für den Server bezahlst, kannst du ohne zusätzliche Kosten so viele Projekte erstellen, wie die Ressourcen-Verwendung zulässt.
  2. Für die Zukunft behalten wir uns die Option vor, die Erstellung von Standalone-Projekten anzubieten. Das werden Projekte sein, die nicht Teil eines Servers sind und auf einem gemeinsamen Ressourcen-Pool erstellt werden. Du wirst für die von dem Projekt genutzten Ressourcen bezahlen und so viele Projekte erstellen können, wie du möchtest.

Ein Projekt erstellen...​

...auf einem Server​

Voraussetzung dafür, ein Projekt auf einem bestehenden Server zu erstellen, ist die ID dieses Servers. Du kannst alle Server finden, auf die du Zugriff hast, indem du den GET /v2/servers-API-Endpunkt verwendest.

Um ein neues Projekt zu erstellen, sende eine POST-Anfrage an den /v2/servers/{serverID}/projects-Endpunkt. Der Anfragetext muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

  • description (String, Pflichtfeld) sollte eine menschenlesbare Beschreibung des Projekts enthalten.

Die Antwort im Erfolgsfall enthält ein JSON-Objekt mit den folgenden Eigenschaften:

  • id ist die ID des neu erstellten Projekts.
info
Für Details siehe auch die Endpoint-Dokumentation für den folgenden API-Endpoint: project-create-project

...als Standalone-Projekt​

note

Das Erstellen von Standalone-Projekten wird derzeit nicht unterstützt.

Überprüfen der Projekt-Verfügbarkeit​

Ein neu erstelltes Projekt ist nicht sofort verfügbar (sollte es jedoch innerhalb weniger Sekunden sein). Um zu überprüfen, ob ein Projekt bereit ist, sende eine GET-Anfrage an den /v2/projects/{projectID}-Endpunkt. Unter anderem enthält die Antwort eine isReady-Eigenschaft. Diese Eigenschaft ist true, wenn das Projekt bereitgestellt und verfügbar ist, und andernfalls false.

info
Für Details siehe auch die Endpoint-Dokumentation für den folgenden API-Endpoint: project-get-project

Footnotes​

  1. https://www.mittwald.de/space-server ↩