Obtention de la cle#

Obtenez le token d’authentification dans les parametres utilisateur, puis copiez la cle generee pour acceder a l’API.

Parametres de la cle API

Cle API

Specification#

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

Authentification : Incluez l’en-tete X-Auth-Key avec la valeur de votre token API.

Methodes disponibles#

Methode Endpoint Description
GET /me Informations sur l’utilisateur
GET /domains/ Liste des domaines
GET /domains/{domain} Details d’un domaine specifique
POST /domains/ Creation d’un nouveau domaine
PATCH /domains/{domain} Mise a jour des parametres du domaine
DELETE /domains/{domain} Suppression d’un domaine
GET /domains/{domain}/uptime Statistiques du temps de reponse du serveur
GET /tasks/ Taches actives de generation de certificats
GET /security/iplist/ Inventaire des listes d’IP
POST /security/iplist/ Creation d’une liste d’IP
PATCH /security/iplist/{listid} Mise a jour d’une liste d’IP
DELETE /security/iplist/{listid} Suppression d’une liste d’IP
PUT /security/iplist/{listid}/{ip} Ajout d’une IP a la liste de blocage
DELETE /security/iplist/{listid}/{ip} Suppression d’une IP de la liste de blocage
GET /nodes/ Liste des nodes

Exemples de requetes#

Informations sur l’utilisateur#

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

Liste des domaines#

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

Obtention d’un domaine specifique#

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

Creation d’un domaine#

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

Modification d’un domaine#

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

Vous pouvez transmettre UNIQUEMENT les parametres a modifier.

Suppression d’un domaine#

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

Creation d’une liste de blocage d’IP#

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

Ajout d’une IP a la liste de blocage#

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

Suppression d’une IP de la liste de blocage#

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