HTTP API

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

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

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

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

Базовый урл 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/	Список нод

Информация

# пример для 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,				// активность SSL
    "tags": ["tag1","tag2"],	// список тегов
    "backend": "127.0.0.1",		// Бекенд
    "fhttps": true,				// Принудительный редирект с http на https
    "cachelevel": 1				// Уровень кеширования
}'

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

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

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

Удаление домена

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

Создать список блокировки

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