Skip to content
Silux Connect
Browse all help topics

API keys

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

Where: /settings/api-keysWho: Workspace owners
On this page

Create a key

  1. Press New key.
  2. Give it a Name (e.g. “Acme support widget”).
  3. Tick the Scopes it needs: tickets:read, tickets:write, devices:read, devices:write, devices:enroll, sessions:read, recordings:read, alerts:read, alerts:write, audit:read, kb:read, kb:write, webhooks:write.
  4. Optionally set Expires at (optional), then Create key.
  5. Copy your key now — “This is the only time the raw value is shown.” Tick I have saved this key in a secure place. and press Done.
Enrolling agents: A key with only devices:enroll is what you pass to silux-agent enroll --token. See Install the agent.

Using and revoking keys

Send the key in the X-Silux-Api-Key header to any /api/v1/* endpoint (see the REST API reference). Active keys shows each key’s scopes and state (active, expired, revoked); Revoke stops it working, Delete removes it from the list.

Related help

Install the agent on Windows, macOS, Ubuntu and Debian
Install the Silux Connect host agent as a background service, enrol it into your workspace, and grant the macOS permissions it needs.
Integrations
Connect Slack, Microsoft Teams, Jira, ServiceNow, Freshservice, Zendesk, PagerDuty, Stripe, QuickBooks, Xero, Microsoft 365 and Google Workspace.