HTTP API

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

Получение ключа#

Получаем свой токен в настройках пользователя.

И копируем полученный ключ.

Спецификация#

Базовый URL: https://api.privateflare.com

Для авторизации необходимо передать заголовок X-Auth-Key со значением API ключа.

Доступные методы#

Метод	Путь	Описание
GET	`/me`	Информация о пользователе
GET	`/domains/`	Список доменов
GET	`/domains/{domain}`	Детали по выбранному домену
POST	`/domains/`	Создать новый домен
PATCH	`/domains/{domain}`	Обновить параметры домена
DELETE	`/domains/{domain}`	Удалить домен
GET	`/domains/{domain}/uptime`	Статистика по времени ответа сервера
GET	`/tasks/`	Активные задачи на генерацию сертификатов
GET	`/security/iplist/`	Список списков IP
POST	`/security/iplist/`	Создать список IP
PATCH	`/security/iplist/{listid}`	Обновить список IP
DELETE	`/security/iplist/{listid}`	Удалить список IP
PUT	`/security/iplist/{listid}/{ip}`	Добавить IP в список блокировки
DELETE	`/security/iplist/{listid}/{ip}`	Удалить IP из списка блокировки
GET	`/nodes/`	Список нод
GET	`/domains/{domain}/dnsrecords`	DNS записи домена
POST	`/domains/{domain}/dnsrecords`	Создать DNS запись
PATCH	`/domains/{domain}/dnsrecords/{id}`	Обновить DNS запись
DELETE	`/domains/{domain}/dnsrecords/{id}`	Удалить DNS запись
GET	`/domains/{domain}/certexport`	Экспорт SSL сертификата (ZIP)
GET	`/domains/{domain}/activatens`	Активировать NS записи
GET	`/domains/{domain}/deactivatens`	Деактивировать NS записи

Информация#

# пример для cURL
curl --location 'https://api.privateflare.com/me/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Список доменов#

# пример для cURL
curl --location 'https://api.privateflare.com/domains/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Один домен#

# пример для cURL
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'

Создание домена#

# пример для 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
}'

Поле	Тип	Описание
`enabled`	bool	Активность домена
`domain`	string	Имя домена
`mask`	string	Маска домена
`ssl`	bool	Активность SSL
`tags`	string[]	Список тегов
`backend`	string	IP бекенда
`failover`	string	IP резервного бекенда
`fhttps`	bool	Принудительный редирект с http на https
`cachelevel`	int	Уровень кеширования (0-3)
`sjschallenge`	bool	JS Challenge (аналог Under Attack)
`baseprotection`	bool	Базовая WAF защита
`bwlimit`	int	Лимит пропускной способности, KB/s (0 = без ограничений)
`geomode`	int	Гео-фильтрация: 0=выкл, 1=разрешить только, 2=заблокировать
`geolist`	string[]	Список кодов стран (ISO 3166-1 alpha-2)
`bind_node`	int[]	Привязка к конкретным нодам (пустой = все ноды)
`cachelargefiles`	bool	Кеширование больших файлов на нодах

Модификация параметров домена#

# пример для cURL
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--data '{
    "enabled": true
}'

Обратите внимание, что можно передавать ТОЛЬКО ИЗМЕНЯЕМЫЕ параметры.

Keitaro: как подключить домены

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

Делайте все по стандартной инструкции.

не забудьте отключить принудительный редирект на HTTPS!

Это нормально:

Потому что сертификаты теперь управляются PFом и кейтаро не может их выпустить. Просто используйте домены как обычно.

Решение проблем: не генерируются сертификаты

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

О любых проблемах на сервисе вы будете оповещены практически сразу. Если вы не получили оповещение - значит все работает как надо. А теперь к сути.

Быстрая проверка#

Любой домен в сервисе отвечает на пинги сервиса генерации сертификатов по адресу:

http://<домен>/.well-known/acme-challenge/ping тут он должен ответить pong

Это можно использовать для бглой проверки правильности настройки домена.

Нода#

Проверяем доступность ноды

Для этого в браузере просто открываем ип ноды.

Это хороший ответ: нода жива, подключена к мастеру и готова обслуживать трафик.

Техническая документация on PrivateFlare Docs