HTTP API

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

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.

Keitaro : comment connecter les domaines

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

Suivez le guide standard.

N’oubliez pas de désactiver la redirection forcée vers HTTPS !

C’est normal :

En effet, les certificats sont désormais gérés par PF et Keitaro ne peut pas les émettre. Utilisez simplement les domaines comme d’habitude.

Résolution de problèmes : les certificats ne se génèrent pas

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

Vous serez notifié de tout problème sur le service presque immédiatement. Si vous n’avez pas reçu de notification, cela signifie que tout fonctionne correctement. Passons maintenant au sujet.

Vérification rapide#

Tout domaine du service répond aux pings du service de génération de certificats à l’adresse :

http://<domaine>/.well-known/acme-challenge/ping il doit répondre pong

Cela peut être utilisé pour une vérification rapide de la bonne configuration du domaine.

Noeud#

Vérifiez la disponibilité du noeud.

Documentation technique on PrivateFlare Docs