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'