Skip to content
Silux Connect
Browse all help topics

API Docs

Public API documentation inside the console: overview, live spec, quick start with a sandbox key, scopes, endpoints, webhooks and SDKs.

Where: /admin/api-docsWho: Platform super-admins

Tabs

Overview
Base path /api/v1/*, JSON, tenant-scoped keys; authentication, versioning (additive within v1, 90-day deprecation), rate limits (100 requests/minute per key by default).
Live spec
The OpenAPI specification rendered live (also at /api/docs).
Quick start
Issue a sandbox key (24h) — read-only for tickets and KB — then curl examples to create, list and fetch tickets.
Scopes
Every scope and what it unlocks.
Endpoints
Pulled live from the server’s route list; copy a curl for any endpoint.
Webhooks
Outbound event catalogue (ticket, KB, device, session and alert events), inbound webhooks, and HMAC signature verification (X-Silux-Signature, reject timestamps older than 5 minutes).
SDKs · Changelog
Client examples and the backward-compatibility policy.

Related help

API keys
Scoped, workspace-bound keys for integrations and for enrolling agents.