Getting Your Key#
Obtain an authentication token in the user settings, then copy the generated key for API access.
Specification#
Base URL: https://api.privateflare.com
Authentication: Include the X-Auth-Key header with your API token value.
Available Methods#
| Method | Endpoint | Description |
|---|---|---|
| GET | /me | User information |
| GET | /domains/ | List of domains |
| GET | /domains/{domain} | Details of a specific domain |
| POST | /domains/ | Create a new domain |
| PATCH | /domains/{domain} | Update domain parameters |
| DELETE | /domains/{domain} | Delete a domain |
| GET | /domains/{domain}/uptime | Server response time statistics |
| GET | /tasks/ | Active certificate generation tasks |
| GET | /security/iplist/ | IP list inventory |
| POST | /security/iplist/ | Create an IP list |
| PATCH | /security/iplist/{listid} | Update an IP list |
| DELETE | /security/iplist/{listid} | Delete an IP list |
| PUT | /security/iplist/{listid}/{ip} | Add an IP to a blocklist |
| DELETE | /security/iplist/{listid}/{ip} | Remove an IP from a blocklist |
| GET | /nodes/ | List of nodes |
Request Examples#
User Information#
curl --location 'https://api.privateflare.com/me/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'List of Domains#
curl --location 'https://api.privateflare.com/domains/' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'Get a Specific Domain#
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'Create a Domain#
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
}'Update a Domain#
curl --location 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx' \
--data '{
"enabled": true
}'You can pass ONLY the parameters being changed.
Delete a Domain#
curl --location --request DELETE 'https://api.privateflare.com/domains/domain.com' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'Create an IP Blocklist#
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": []
}'Add an IP to a Blocklist#
curl --location --request PUT 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'Remove an IP from a Blocklist#
curl --location --request DELETE 'https://api.privateflare.com/security/iplist/6/2.2.2.2' \
--header 'X-Auth-Key: xxxxxxxxxxxxxxxxxxxxxxxx'