Websites

Websites

Websites repräsentieren die veröffentlichten Webauftritte innerhalb eines Projekts. Jede Website hat eine eigene Subdomain oder kann mit einer Custom Domain verbunden werden.

Endpunkte

MethodeEndpunktBeschreibung
GET/api/v1/websitesAlle Websites auflisten
POST/api/v1/websitesNeue Website erstellen
GET/api/v1/websites/{id}Einzelne Website abrufen
PUT/api/v1/websites/{id}Website vollständig aktualisieren
PATCH/api/v1/websites/{id}Website teilweise aktualisieren
DELETE/api/v1/websites/{id}Website löschen
POST/api/v1/websites/{id}/faviconFavicon hochladen
DELETE/api/v1/websites/{id}/faviconFavicon entfernen
POST/api/v1/websites/{id}/og-imageOG-Image hochladen
DELETE/api/v1/websites/{id}/og-imageOG-Image entfernen

Domain-Verwaltung

MethodeEndpunktBeschreibung
GET/api/v1/websites/check-subdomainSubdomain-Verfügbarkeit prüfen
GET/api/v1/websites/domain-statusDomain-Status abrufen
POST/api/v1/websites/generate-verification-tokenVerifizierungstoken generieren
POST/api/v1/websites/verify-domainCustom Domain verifizieren

Das Website-Objekt

{ "id": "web_abc123", "projectId": "proj_xyz789", "organizationId": "org_def456", "name": "Hauptwebsite", "subdomain": "meine-firma", "customDomain": "www.meine-firma.de", "domainVerified": true, "status": "published", "favicon": "https://cdn.codefluss.com/media/favicon_123.ico", "ogImage": "https://cdn.codefluss.com/media/og_456.png", "seo": { "title": "Meine Firma - Startseite", "description": "Willkommen bei Meine Firma", "keywords": ["firma", "dienstleistung"] }, "analytics": { "googleAnalyticsId": "G-XXXXXXXXXX", "enabled": true }, "createdAt": "2026-01-10T08:00:00Z", "updatedAt": "2026-01-22T15:30:00Z" }

Attribute

AttributTypBeschreibung
idstringEindeutige Website-ID (Präfix: web_)
projectIdstringZugehöriges Projekt
organizationIdstringZugehörige Organisation
namestringWebsite-Name
subdomainstringSubdomain (z.B. meine-firma.codefluss.app)
customDomainstringOptionale Custom Domain
domainVerifiedbooleanOb die Custom Domain verifiziert ist
statusstringdraft, published, maintenance
faviconstringURL zum Favicon
ogImagestringURL zum OG-Image für Social Sharing
seoobjectSEO-Konfiguration
analyticsobjectAnalytics-Konfiguration
createdAtstringErstellungszeitpunkt
updatedAtstringLetzte Aktualisierung

Websites auflisten

GET /api/v1/websites

Query-Parameter

ParameterTypDefaultBeschreibung
organizationIdstringPflichtOrganisations-ID
projectIdstringFilter nach Projekt
statusstringFilter: draft, published, maintenance
pageinteger1Seitennummer
pageSizeinteger20Einträge pro Seite

Beispiel-Response

{ "success": true, "data": [ { "id": "web_abc123", "projectId": "proj_xyz789", "name": "Hauptwebsite", "subdomain": "meine-firma", "status": "published", "createdAt": "2026-01-10T08:00:00Z" } ], "pagination": { "currentPage": 1, "pageSize": 20, "totalItems": 1, "totalPages": 1 } }

Website erstellen

POST /api/v1/websites

Request-Body

{ "projectId": "proj_xyz789", "organizationId": "org_def456", "name": "Neue Website", "subdomain": "neue-website", "seo": { "title": "Neue Website", "description": "Beschreibung für Suchmaschinen" } }

Pflichtfelder

FeldTypBeschreibung
projectIdstringZiel-Projekt
organizationIdstringZiel-Organisation
namestringWebsite-Name
subdomainstringGewünschte Subdomain

Subdomain prüfen

GET /api/v1/websites/check-subdomain?subdomain={subdomain}

Beispiel-Response

{ "success": true, "data": { "subdomain": "meine-firma", "available": true } }
{ "success": true, "data": { "subdomain": "codefluss", "available": false, "reason": "reserved" } }

Custom Domain einrichten

1. Verifizierungstoken generieren

POST /api/v1/websites/generate-verification-token
{ "websiteId": "web_abc123", "domain": "www.meine-firma.de" }

Response

{ "success": true, "data": { "token": "codefluss-verification=abc123xyz", "recordType": "TXT", "recordName": "_codefluss-verification", "recordValue": "abc123xyz" } }

2. DNS-Eintrag erstellen

Erstellen Sie einen TXT-Eintrag bei Ihrem DNS-Provider:

TypNameWert
TXT_codefluss-verificationabc123xyz

3. Domain verifizieren

POST /api/v1/websites/verify-domain
{ "websiteId": "web_abc123", "domain": "www.meine-firma.de" }

Response

{ "success": true, "data": { "domain": "www.meine-firma.de", "verified": true, "ssl": { "status": "provisioning", "estimatedTime": "5-10 minutes" } } }

Favicon hochladen

POST /api/v1/websites/{id}/favicon Content-Type: multipart/form-data

Request

curl -X POST "https://api.codefluss.com/v1/websites/web_abc123/favicon" \ -H "Authorization: Bearer cf_live_abc123..." \ -F "file=@/path/to/favicon.ico"

Unterstützte Formate

  • .ico (empfohlen, max 256x256px)
  • .png (max 512x512px)
  • .svg

OG-Image hochladen

POST /api/v1/websites/{id}/og-image Content-Type: multipart/form-data

Empfohlene Größe

  • 1200 x 630 Pixel (Facebook, LinkedIn)
  • Format: PNG oder JPEG
  • Max. Dateigröße: 5 MB

Website löschen

DELETE /api/v1/websites/{id}

Warnung: Dies löscht unwiderruflich alle zugehörigen Seiten und Konfigurationen.

Fehler

CodeBeschreibung
400Ungültige Anfrage
401Nicht authentifiziert
403Keine Berechtigung
404Website nicht gefunden
409Subdomain bereits vergeben

Nächste Schritte

  • Seiten – Seiten einer Website verwalten
  • Media – Bilder und Dateien hochladen