Skip to main content

HTTP API

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

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

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

image.png

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

Postman collection

Базовый урл 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/ Активные задачи на генерацию сертификатов
Информация
# пример для 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
    "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'