HTTP API

Отримання ключа#

Отримайте токен автентифікації в налаштуваннях користувача, потім скопіюйте згенерований ключ для доступу до API.

Налаштування API ключа

API ключ

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

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

Автентифікація: Додайте заголовок X-Auth-Key зі значенням вашого API-токена.

Доступні методи#

Метод	Endpoint	Опис
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/	Список нод

Приклади запитів#

Інформація про користувача#

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

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

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

Отримання конкретного домену#

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

Створення домену#

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

Зміна домену#

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

Можна передавати ЛИШЕ ЗМІНЮВАНІ параметри.

Видалення домену#

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

Створення 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": []
}'

Додавання IP до блоклісту#

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

Видалення IP з блоклісту#

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