Entwickler

API-Referenz

Websites per Code erstellen und verwalten.

Mit der Droply-API erstellen Sie Websites und starten Deployments aus Ihren eigenen Skripten und aus Integrationen (die GPT Action für ChatGPT, n8n, VS Code und die Chrome-Erweiterung nutzen sie alle). Die maschinenlesbare Spezifikation finden Sie unter /api/v1/openapi.json (OpenAPI 3.1).

Basis-URL

https://droply.host/api/v1

Authentifizierung

Erstellen Sie in Ihrem Dashboard unter API tokens ein persönliches Zugriffstoken und senden Sie es bei jeder Anfrage als Bearer-Token mit. Der API-Zugang setzt einen kostenpflichtigen Tarif voraus.

Authorization: Bearer YOUR_TOKEN

So prüfen Sie ein Token jederzeit:

curl https://droply.host/api/v1/user \
  -H "Authorization: Bearer YOUR_TOKEN"

Tokens, die Sie auf der Seite API tokens erstellen, haben Full access (Vollzugriff). Den brauchen Sie, um die Einstellungen einer Website zu ändern, eine Website zu löschen, einen Entwurf zu veröffentlichen oder auf eine frühere Version zurückzusetzen. Die reinen Deploy-Tokens, die die Browser- und Editor-Erweiterungen bei der Anmeldung anlegen, können Websites erstellen und veröffentlichen, mehr nicht.

Website erstellen

Reserviert eine Subdomain, die unter <subdomain>.droply.id ausgeliefert wird. Wenn Sie subdomain weglassen, wählt Droply eine freie aus.

curl -X POST https://droply.host/api/v1/sites \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subdomain":"my-portfolio","name":"My Portfolio"}'

Website finden

Website- und Deployment-IDs sind UUIDs. Um die ID einer Website zu finden, ohne die ganze Liste durchzublättern, filtern Sie nach Subdomain oder nach der Adresse, die Besucher eingeben (ihre Droply-Adresse oder eine verbundene eigene Domain):

curl "https://droply.host/api/v1/sites?subdomain=my-portfolio" \
  -H "Authorization: Bearer YOUR_TOKEN"

curl "https://droply.host/api/v1/sites?host=www.example.com" \
  -H "Authorization: Bearer YOUR_TOKEN"

Deployment starten

Laden Sie eine Datei hoch (eine HTML-Datei, eine ZIP-Datei mit einer statischen Website, ein PDF oder ein Bild) oder senden Sie reines HTML. Die Dateiendung bestimmt, wie die Datei ausgeliefert wird, senden Sie sie also unter ihrem echten Namen. Die Verarbeitung läuft asynchron: Der Aufruf antwortet mit 202 und einem Deployment, dessen Status Sie abfragen können.

# ZIP-Datei einer statischen Website hochladen
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]"

# …oder reines HTML veröffentlichen (bis 12 MB; eine größere Seite als Datei senden)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"html":"<!doctype html><h1>Hello</h1>"}'

Deployment-Status abfragen

Fragen Sie den Status ab, bis status den Wert live hat (dann ist live_url enthalten) oder failed (siehe error_message).

curl https://droply.host/api/v1/deployments/DEPLOYMENT_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Entwürfe, Veröffentlichen und Rollback

Fügen Sie einem Deployment draft hinzu, um die Version zu speichern, ohne sie online zu stellen: Sie wird verarbeitet und gescannt und wartet dann im Status staged, während die Website weiter die bisherige Version ausliefert. Veröffentlichen Sie sie, wenn Sie so weit sind, oder stellen Sie eine frühere Version wieder online. Beide Aufrufe antworten mit 202, solange die Änderung in der Warteschlange steht; fragen Sie das Deployment ab, bis es live ist.

# Entwurf speichern (multipart sendet draft=1)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]" -F "draft=1"

# Entwurf veröffentlichen
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/publish \
  -H "Authorization: Bearer YOUR_TOKEN"

# Auf eine frühere Version zurücksetzen (jedes abgelöste Deployment)
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/rollback \
  -H "Authorization: Bearer YOUR_TOKEN"

Passwort und automatischer Ablauf

Geändert wird nur, was Sie senden. password_protected: false entfernt das Passwort; expires_at erwartet Datum und Uhrzeit nach ISO 8601 mit Zeitzonenversatz, oder null, um den Ablauf zu entfernen.

curl -X PATCH https://droply.host/api/v1/sites/SITE_ID \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password":"s3cret-preview","expires_at":"2026-12-01T18:00:00Z"}'

Endpunkte

  • GET /user: das angemeldete Konto und sein Tarif
  • GET /sites: Ihre Websites auflisten (filtern mit subdomain oder host)
  • POST /sites: Website erstellen
  • GET /sites/check?subdomain=: prüfen, ob eine Subdomain frei ist
  • GET /sites/{site}: Website abrufen
  • PATCH /sites/{site}: Name, Passwort oder automatischen Ablauf ändern (Full access)
  • DELETE /sites/{site}: Website löschen (Full access). Eine Website in einem Bereich, der vor versehentlichem Löschen geschützt ist, lässt sich nur im Dashboard löschen. Eine Website, die gesperrt wurde oder von der eine Version für eine Sicherheitsprüfung aufbewahrt wird, antwortet mit 409.
  • POST /sites/{site}/deployments: Deployment starten (Datei oder HTML, optional als Entwurf)
  • GET /sites/{site}/deployments: Deployments einer Website auflisten
  • GET /deployments/{deployment}: Status eines Deployments
  • POST /deployments/{deployment}/retry: fehlgeschlagenes Deployment erneut versuchen
  • POST /deployments/{deployment}/publish: Entwurf veröffentlichen (Full access)
  • POST /deployments/{deployment}/rollback: frühere Version wieder online stellen (Full access)

Fehler und Limits

  • 401: Token fehlt oder ist ungültig.
  • 403: Ihr Tarif umfasst den API-Zugang oder diese Funktion nicht, oder das Token darf diese Aktion nicht ausführen (manche Aktionen brauchen ein Token mit Full access).
  • 404: Die Ressource existiert nicht oder gehört nicht Ihnen.
  • 409: Die Aktion gilt nicht für diese Version (zum Beispiel, wenn Sie eine Version veröffentlichen wollen, die kein Entwurf ist).
  • 413: Der Upload ist größer, als eine einzelne Anfrage transportieren darf (100 MB).
  • 422: Validierung fehlgeschlagen (ein errors-Objekt listet die Felder auf).
  • 429: Rate Limit überschritten. Anfragen werden pro Token gedrosselt, und das Veröffentlichen von Entwürfen sowie Rollbacks sind auf 30 pro Stunde und Konto begrenzt. Warten Sie so viele Sekunden, wie im Header Retry-After angegeben.

Siehe auch