Obtención de la clave#

Obtenga el token de autenticación en la configuración de usuario, luego copie la clave generada para acceder a la API.

Configuracion de clave API

Clave API

Especificación#

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

Autenticación: Incluya el encabezado X-Auth-Key con el valor de su token API.

Métodos disponibles#

Método Endpoint Descripción
GET /me Información del usuario
GET /domains/ Lista de dominios
GET /domains/{domain} Detalles de un dominio específico
POST /domains/ Creación de un nuevo dominio
PATCH /domains/{domain} Actualización de parámetros del dominio
DELETE /domains/{domain} Eliminación de un dominio
GET /domains/{domain}/uptime Estadísticas de tiempo de respuesta del servidor
GET /tasks/ Tareas activas de generación de certificados
GET /security/iplist/ Inventario de listas de IP
POST /security/iplist/ Creación de lista de IP
PATCH /security/iplist/{listid} Actualización de lista de IP
DELETE /security/iplist/{listid} Eliminación de lista de IP
PUT /security/iplist/{listid}/{ip} Agregar IP a la lista de bloqueo
DELETE /security/iplist/{listid}/{ip} Eliminar IP de la lista de bloqueo
GET /nodes/ Lista de nodos

Ejemplos de solicitudes#

Información del usuario#

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

Lista de dominios#

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

Obtención de un dominio específico#

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

Creación de un dominio#

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

Modificación de un dominio#

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

Solo se pueden enviar los parámetros QUE SE MODIFICAN.

Eliminación de un dominio#

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

Creación de lista de bloqueo de 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": []
}'

Agregar IP a la lista de bloqueo#

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

Eliminar IP de la lista de bloqueo#

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