GrootOP API Documentation

Authentication

Clients must provide a Bearer token in the Authorization header:

Authorization: Bearer <your-client-token>

Update Spectrum App

PUT /spectrum/<name>/<app_id>/app

Updates the configuration of the Spectrum app with the specified name and app ID.

Example Request:

{
  "domain": "example.com",
  "origin": "1.2.3.4",
  "port": 25565
}

Example Response:

{
  "status": "success",
  "message": "Spectrum app updated successfully."
}

Analytics (Current)

GET /spectrum/<name>/<app_id>/analytics/current

Returns analytics aggregated from the last minute for the given app.

Example Response:

{
  "total_connections": 25,
  "active_connections": 5,
  "bandwidth_usage": "12.4 MB"
}

List All Apps

GET /spectrum/<name>/apps

Lists all apps.

Example Response:

{
  "apps": [
    {
      "id": "app123",
      "name": "test-shield",
      "domain": "example.com"
    }
  ]
}

Advanced Docs

https://developers.cloudflare.com/api/resources/spectrum/

Follow Cloudflare docs for advanced parameters, queries, example requests and responses.

All responses to our API are same as Cloudflare, just the path is different to provide access to customer own instance.