REST API

The Core exposes a REST API for external integrations and automation.

Authentication

REST API requests use a configurable bearer token. Enable the API and generate a token in Settings. GUI users continue to use JWT authentication.

Allowed actions

Fine-grained permissions control which endpoints a REST token can access:

  • probes_read / probes_write
  • tests_read / tests_write
  • results_read
  • webhooks_read

OpenAPI spec

The Core serves an OpenAPI 3.1.0 specification at /openapi.json when the REST API is enabled. Settings, AI, certificate, and MaxMind endpoints are not exposed to REST tokens.

Example request

curl -H "Authorization: Bearer YOUR_TOKEN"   https://core.linknesis.com/api/probes

© Linknesis. Documentation for the Linknesis network monitoring platform.