DocumentationИнтеграцииREST API

REST API

Programmatic MineGuard management via API

The REST API lets you manage MineGuard programmatically — create networks, change settings, retrieve statistics. Useful for integrating with your own systems or bots.

Authentication

Create an API key in the API keys section of the panel. Pass the key in the Authorization header:

Header
Authorization: Bearer YOUR_API_KEY

Main endpoints

User information

GET /api/user
curl -X GET "https://mineguard.pro/api/user" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Filter status

GET /api/filter/status
curl -X GET "https://mineguard.pro/api/filter/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Network statistics

GET /api/networks/{id}/realtime
curl -X GET "https://mineguard.pro/api/networks/1/realtime" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Full API documentation with interactive examples is available in the API Reference (login required).