Schlüssel abrufen#

Holen Sie sich Ihren Token in den Benutzereinstellungen.

image

Und kopieren Sie den erhaltenen Schlüssel.

image

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.

Domain löschen#
# Beispiel für cURL
curl --location --request DELETE 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'
Sperrliste erstellen#
# Beispiel für cURL
curl --location 'https://api.privateflare.com/security/iplist/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "name": "list name",
    "ips": ["1.1.1.1"],
    "allnodes": true,
    "nodes": []
}'
Feld Beschreibung
name Name der Liste
ips IP-Liste
allnodes Auf allen Nodes verwenden
nodes Liste der Nodes, auf denen die Liste angewendet wird
DNS-Einträge der Domain#
curl --location 'https://api.privateflare.com/domains/domain.com/dnsrecords' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'
DNS-Eintrag erstellen#
curl --location 'https://api.privateflare.com/domains/domain.com/dnsrecords' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--data '{
    "name": "@",
    "type": 1,
    "value": "1.2.3.4",
    "ttl": 3600,
    "target": []
}'
Feld Typ Beschreibung
name string Eintragsname (@ für Root)
type int Eintragstyp: 1=A, 2=AAAA, 3=CNAME, 4=MX, 5=NS, 6=TXT, 7=SOA, 8=SRV
value string Wert des Eintrags
ttl int TTL in Sekunden
priority int Priorität (für MX, SRV)
target int[] Geo-Zuordnung: IDs von Ländern/Kontinenten für GeoDNS (leer = allgemeiner Eintrag)
NS-Einträge aktivieren#

Um den DNS-Service von PrivateFlare (ns1.privateflare.com, ns2.privateflare.com) zu nutzen:

curl --location 'https://api.privateflare.com/domains/domain.com/activatens' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'
IP zur Sperrliste hinzufügen und blockieren#
curl --location --request PUT 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'
IP aus der Sperrliste entfernen und freigeben#
curl --location --request DELETE 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'
Backward Technische Dokumentation Keitaro: Domains verbinden Forward