HTTP API

Obtention de la clé#

Récupérez votre token dans les paramètres utilisateur.

Et copiez la clé obtenue.

Spécification#

URL de base : https://api.privateflare.com

Pour l’autorisation, il est nécessaire de transmettre l’en-tête X-Auth-Key avec la valeur de la clé API.

Méthodes disponibles#

Méthode	Chemin	Description
GET	`/me`	Informations sur l’utilisateur
GET	`/domains/`	Liste des domaines
GET	`/domains/{domain}`	Détails du domaine sélectionné
POST	`/domains/`	Créer un nouveau domaine
PATCH	`/domains/{domain}`	Mettre à jour les paramètres du domaine
DELETE	`/domains/{domain}`	Supprimer un domaine
GET	`/domains/{domain}/uptime`	Statistiques de temps de réponse du serveur
GET	`/tasks/`	Tâches actives de génération de certificats
GET	`/security/iplist/`	Liste des listes d’IP
POST	`/security/iplist/`	Créer une liste d’IP
PATCH	`/security/iplist/{listid}`	Mettre à jour une liste d’IP
DELETE	`/security/iplist/{listid}`	Supprimer une liste d’IP
PUT	`/security/iplist/{listid}/{ip}`	Ajouter une IP à la liste de blocage
DELETE	`/security/iplist/{listid}/{ip}`	Supprimer une IP de la liste de blocage
GET	`/nodes/`	Liste des noeuds
GET	`/domains/{domain}/dnsrecords`	Enregistrements DNS du domaine
POST	`/domains/{domain}/dnsrecords`	Créer un enregistrement DNS
PATCH	`/domains/{domain}/dnsrecords/{id}`	Mettre à jour un enregistrement DNS
DELETE	`/domains/{domain}/dnsrecords/{id}`	Supprimer un enregistrement DNS
GET	`/domains/{domain}/certexport`	Export du certificat SSL (ZIP)
GET	`/domains/{domain}/activatens`	Activer les enregistrements NS
GET	`/domains/{domain}/deactivatens`	Désactiver les enregistrements NS

Informations#

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

Liste des domaines#

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

Un domaine#

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

Création d’un domaine#

# exemple pour 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
}'

Champ	Type	Description
`enabled`	bool	Activité du domaine
`domain`	string	Nom du domaine
`mask`	string	Masque du domaine
`ssl`	bool	Activité SSL
`tags`	string[]	Liste des tags
`backend`	string	IP du backend
`failover`	string	IP du backend de secours
`fhttps`	bool	Redirection forcée de http vers https
`cachelevel`	int	Niveau de mise en cache (0-3)
`sjschallenge`	bool	JS Challenge (équivalent d’Under Attack)
`baseprotection`	bool	Protection WAF de base
`bwlimit`	int	Limite de bande passante, Ko/s (0 = sans limitation)
`geomode`	int	Filtrage géographique : 0=désactivé, 1=autoriser uniquement, 2=bloquer
`geolist`	string[]	Liste des codes pays (ISO 3166-1 alpha-2)
`bind_node`	int[]	Association à des noeuds spécifiques (vide = tous les noeuds)
`cachelargefiles`	bool	Mise en cache des gros fichiers sur les noeuds

Modification des paramètres du domaine#

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

Notez que vous pouvez transmettre UNIQUEMENT LES PARAMETRES A MODIFIER.

Suppression d’un domaine#

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

Créer une liste de blocage#

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

Champ	Description
`name`	Nom de la liste
`ips`	Liste des IP
`allnodes`	Utiliser sur tous les noeuds
`nodes`	Liste des noeuds sur lesquels la liste sera appliquée

Enregistrements DNS du domaine#

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

Création d’un enregistrement DNS#

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

Champ	Type	Description
`name`	string	Nom de l’enregistrement (`@` pour la racine)
`type`	int	Type d’enregistrement : 1=A, 2=AAAA, 3=CNAME, 4=MX, 5=NS, 6=TXT, 7=SOA, 8=SRV
`value`	string	Valeur de l’enregistrement
`ttl`	int	TTL en secondes
`priority`	int	Priorité (pour MX, SRV)
`target`	int[]	Géo-association : ID des pays/continents pour le GeoDNS (vide = enregistrement général)

Activation des enregistrements NS#

Pour utiliser le service DNS de PrivateFlare (ns1.privateflare.com, ns2.privateflare.com) :

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

Ajouter une IP à la liste de blocage et bloquer#

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

Supprimer une IP de la liste de blocage et débloquer#

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