Schlüssel erhalten#

Holen Sie sich den Authentifizierungstoken in den Benutzereinstellungen und kopieren Sie dann den generierten Schlüssel für den API-Zugriff.

API-Schlussel-Einstellungen

API-Schlussel

Spezifikation#

Base URL: https://api.privateflare.com

Authentifizierung: Fügen Sie den Header X-Auth-Key mit dem Wert Ihres API-Tokens hinzu.

Verfügbare Methoden#

Methode Endpoint Beschreibung
GET /me Benutzerinformationen
GET /domains/ Domain-Liste
GET /domains/{domain} Details einer bestimmten Domain
POST /domains/ Neue Domain erstellen
PATCH /domains/{domain} Domain-Parameter aktualisieren
DELETE /domains/{domain} Domain löschen
GET /domains/{domain}/uptime Server-Antwortzeit-Statistiken
GET /tasks/ Aktive Zertifikatsgenerierungs-Aufgaben
GET /security/iplist/ IP-Listen-Inventar
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 Blockliste hinzufügen
DELETE /security/iplist/{listid}/{ip} IP aus der Blockliste entfernen
GET /nodes/ Node-Liste

Beispielanfragen#

Benutzerinformationen#

curl --location 'https://api.privateflare.com/me/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Domain-Liste#

curl --location 'https://api.privateflare.com/domains/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Bestimmte Domain abrufen#

curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Domain erstellen#

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
}'

Domain ändern#

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

Es können NUR die ZU ÄNDERNDEN Parameter übergeben werden.

Domain löschen#

curl --location --request DELETE 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

IP-Blockliste erstellen#

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": []
}'

IP zur Blockliste hinzufügen#

curl --location --request PUT 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

IP aus der Blockliste entfernen#

curl --location --request DELETE 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'