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
| Methode | Endpunkt | Beschreibung |
|---|
GET | /api/v1/websites | Alle Websites auflisten |
POST | /api/v1/websites | Neue 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}/favicon | Favicon hochladen |
DELETE | /api/v1/websites/{id}/favicon | Favicon entfernen |
POST | /api/v1/websites/{id}/og-image | OG-Image hochladen |
DELETE | /api/v1/websites/{id}/og-image | OG-Image entfernen |
Domain-Verwaltung
| Methode | Endpunkt | Beschreibung |
|---|
GET | /api/v1/websites/check-subdomain | Subdomain-Verfügbarkeit prüfen |
GET | /api/v1/websites/domain-status | Domain-Status abrufen |
POST | /api/v1/websites/generate-verification-token | Verifizierungstoken generieren |
POST | /api/v1/websites/verify-domain | Custom 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
| Attribut | Typ | Beschreibung |
|---|
id | string | Eindeutige Website-ID (Präfix: web_) |
projectId | string | Zugehöriges Projekt |
organizationId | string | Zugehörige Organisation |
name | string | Website-Name |
subdomain | string | Subdomain (z.B. meine-firma.codefluss.app) |
customDomain | string | Optionale Custom Domain |
domainVerified | boolean | Ob die Custom Domain verifiziert ist |
status | string | draft, published, maintenance |
favicon | string | URL zum Favicon |
ogImage | string | URL zum OG-Image für Social Sharing |
seo | object | SEO-Konfiguration |
analytics | object | Analytics-Konfiguration |
createdAt | string | Erstellungszeitpunkt |
updatedAt | string | Letzte Aktualisierung |
Websites auflisten
Query-Parameter
| Parameter | Typ | Default | Beschreibung |
|---|
organizationId | string | Pflicht | Organisations-ID |
projectId | string | – | Filter nach Projekt |
status | string | – | Filter: draft, published, maintenance |
page | integer | 1 | Seitennummer |
pageSize | integer | 20 | Einträ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
Request-Body
{
"projectId": "proj_xyz789",
"organizationId": "org_def456",
"name": "Neue Website",
"subdomain": "neue-website",
"seo": {
"title": "Neue Website",
"description": "Beschreibung für Suchmaschinen"
}
}
Pflichtfelder
| Feld | Typ | Beschreibung |
|---|
projectId | string | Ziel-Projekt |
organizationId | string | Ziel-Organisation |
name | string | Website-Name |
subdomain | string | Gewü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:
| Typ | Name | Wert |
|---|
| TXT | _codefluss-verification | abc123xyz |
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
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"
.ico (empfohlen, max 256x256px)
.png (max 512x512px)
.svg
OG-Image hochladen
POST /api/v1/websites/{id}/og-image
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
| Code | Beschreibung |
|---|
400 | Ungültige Anfrage |
401 | Nicht authentifiziert |
403 | Keine Berechtigung |
404 | Website nicht gefunden |
409 | Subdomain bereits vergeben |
Nächste Schritte
- Seiten – Seiten einer Website verwalten
- Media – Bilder und Dateien hochladen