HTTP API

Thu, 22 Jan 2026 00:00:00 +0000

Schlüssel abrufen#

Holen Sie sich Ihren Token in den Benutzereinstellungen.

Und kopieren Sie den erhaltenen Schlüssel.

Spezifikation#

Basis-URL: https://api.privateflare.com

Für die Autorisierung muss der Header X-Auth-Key mit dem Wert des API-Schlüssels übergeben werden.

Verfügbare Methoden#

Methode	Pfad	Beschreibung
GET	`/me`	Benutzerinformationen
GET	`/domains/`	Domain-Liste
GET	`/domains/{domain}`	Details zur ausgewählten Domain
POST	`/domains/`	Neue Domain erstellen
PATCH	`/domains/{domain}`	Domain-Parameter aktualisieren
DELETE	`/domains/{domain}`	Domain löschen
GET	`/domains/{domain}/uptime`	Statistik zur Serverantwortzeit
GET	`/tasks/`	Aktive Aufgaben zur Zertifikatsgenerierung
GET	`/security/iplist/`	Liste der IP-Listen
POST	`/security/iplist/`	IP-Liste erstellen
PATCH	`/security/iplist/{listid}`	IP-Liste aktualisieren
DELETE	`/security/iplist/{listid}`	IP-Liste löschen
PUT	`/security/iplist/{listid}/{ip}`	IP zur Sperrliste hinzufügen
DELETE	`/security/iplist/{listid}/{ip}`	IP aus der Sperrliste entfernen
GET	`/nodes/`	Node-Liste
GET	`/domains/{domain}/dnsrecords`	DNS-Einträge der Domain
POST	`/domains/{domain}/dnsrecords`	DNS-Eintrag erstellen
PATCH	`/domains/{domain}/dnsrecords/{id}`	DNS-Eintrag aktualisieren
DELETE	`/domains/{domain}/dnsrecords/{id}`	DNS-Eintrag löschen
GET	`/domains/{domain}/certexport`	SSL-Zertifikat exportieren (ZIP)
GET	`/domains/{domain}/activatens`	NS-Einträge aktivieren
GET	`/domains/{domain}/deactivatens`	NS-Einträge deaktivieren

Informationen#

# Beispiel für cURL
curl --location 'https://api.privateflare.com/me/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Domain-Liste#

# Beispiel für cURL
curl --location 'https://api.privateflare.com/domains/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Einzelne Domain#

# Beispiel für cURL
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Domain erstellen#

# Beispiel für cURL
curl --location 'https://api.privateflare.com/domains/' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--data '{
 "enabled": true,
 "domain": "domain.com",
 "mask": "yandex.info",
 "ssl": true,
 "tags": ["tag1","tag2"],
 "backend": "127.0.0.1",
 "fhttps": true,
 "cachelevel": 1
}'

Feld	Typ	Beschreibung
`enabled`	bool	Domain-Aktivität
`domain`	string	Domainname
`mask`	string	Domain-Maske
`ssl`	bool	SSL-Aktivität
`tags`	string[]	Liste der Tags
`backend`	string	Backend-IP
`failover`	string	IP des Reserve-Backends
`fhttps`	bool	Erzwungene Weiterleitung von HTTP auf HTTPS
`cachelevel`	int	Caching-Stufe (0-3)
`sjschallenge`	bool	JS Challenge (Entsprechung von Under Attack)
`baseprotection`	bool	Basis-WAF-Schutz
`bwlimit`	int	Bandbreitenlimit, KB/s (0 = ohne Begrenzung)
`geomode`	int	Geo-Filterung: 0=aus, 1=nur erlauben, 2=blockieren
`geolist`	string[]	Liste der Ländercodes (ISO 3166-1 alpha-2)
`bind_node`	int[]	Zuordnung zu bestimmten Nodes (leer = alle Nodes)
`cachelargefiles`	bool	Caching großer Dateien auf den Nodes

Domain-Parameter ändern#

# Beispiel für cURL
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--data '{
 "enabled": true
}'

Beachten Sie, dass NUR DIE ZU ÄNDERNDEN Parameter übergeben werden können.

Keitaro: Domains verbinden

Wed, 11 Sep 2024 00:00:00 +0000

Gehen Sie nach der Standardanleitung vor.

Vergessen Sie nicht, die erzwungene HTTPS-Weiterleitung zu deaktivieren!

Das ist normal:

Die Zertifikate werden nun von PF verwaltet und Keitaro kann sie nicht ausstellen. Verwenden Sie die Domains einfach wie gewohnt.

Problemlösung: Zertifikate werden nicht generiert

Tue, 26 Dec 2023 00:00:00 +0000

Über jegliche Probleme im Service werden Sie nahezu sofort benachrichtigt. Wenn Sie keine Benachrichtigung erhalten haben, funktioniert alles wie vorgesehen. Nun aber zum Kern der Sache.

Schnellprüfung#

Jede Domain im Service antwortet auf Pings des Zertifikatsgenerierungs-Services unter folgender Adresse:

http://<domain>/.well-known/acme-challenge/ping hier sollte die Antwort pong lauten

Dies können Sie für eine schnelle Überprüfung der korrekten Domain-Konfiguration verwenden.

Node#

Wir prüfen die Erreichbarkeit der Node.

Dazu öffnen wir einfach die IP der Node im Browser.

Technische Dokumentation on PrivateFlare Docs