RESTful API

Not available in the current build

The configuration described on this page is ignored or rejected by the current version of Specola Core. It is kept for reference only. See Full Configuration for what is supported.

The desktop UI normally uses local IPC. An optional [general].api-listen exposes the same API over loopback TCP for integrations.

[general]
api-listen = "127.0.0.1:9090"
api-secret = "replace-with-a-long-random-secret"

Keep the controller on loopback unless a separate trusted network boundary protects it. The secret authenticates requests but does not make an exposed plain-HTTP controller confidential. Sensitive operations and credentials must not cross an untrusted network.

Responses use a consistent success/error envelope; always check both the HTTP status and the operation result. The API covers system status, connections, traffic, proxies and groups, configuration and rules, DNS/network data, providers, subscriptions, tools, and events. Mutation endpoints update the active runtime snapshot and may have persistence or selection side effects.

Use Tools for latency and NAT examples. Consult the shipped OpenAPI contract for the exact fields and routes supported by the running version.