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 і Keitaro не може їх випустити. Просто використовуйте домени як зазвичай.

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

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

Про будь-які проблеми на сервісі ви будете сповіщені практично одразу. Якщо ви не отримали сповіщення — значить усе працює як потрібно. А тепер до суті.

Швидка перевірка#

Будь-який домен у сервісі відповідає на пінги сервісу генерації сертифікатів за адресою:

http://<домен>/.well-known/acme-challenge/ping тут він повинен відповісти pong

Це можна використовувати для швидкої перевірки правильності налаштування домену.

Нода#

Перевіряємо доступність ноди

Для цього у браузері просто відкриваємо іп ноди.

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

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