Connect your first 3CX instance

From dashboard to live polling in about five minutes.

When you click Add an instance on the dashboard, Sikurd asks one question first: one or many?

  • One → a simple form: paste the FQDN, give it a friendly name, hit save.
  • Many → a CSV importer, or (on Pro+) an AI screenshot tool that reads a list of FQDNs out of a screenshot.

This walkthrough covers the one path. The bulk paths get their own articles (CSV import and AI onboarding).

Step 1 — Add the instance

  1. On the dashboard, click Add an instance (top right) or jump into Instances → Add.
  2. Enter the FQDN — that's the URL of the 3CX management console without https:// (e.g. acme.3cx.us).
  3. Give it a display name. It can be anything; "Acme HQ" works fine.
  4. Save.

Sikurd creates the instance row and asks you to add credentials.

Step 2 — Add credentials

Sikurd needs to log in to your 3CX to poll metrics. We support two auth modes:

  • Username + password — works on every 3CX edition. Recommended for most cases.
  • OAuth client credentials — for v20.0+ instances with an API client configured. Click Use OAuth instead under the form to switch.

Either way:

  1. Open the 3CX admin console for the instance.
  2. (Username/password path) Go to Admin → Users, find the "API user" or your admin account. Or create a dedicated Sikurd user with the System owner role.
  3. (OAuth path) Go to Admin → API → Add and create an OAuth client with management scope. Copy the Client ID and Client Secret.
  4. Paste the credentials into Sikurd's form. Click Connect.

If the credentials are good, you'll see "✓ Connected" within a few seconds and the instance row flips to green.

Step 3 — Wait for the first poll

The worker picks up new instances on its next polling cycle (usually within 60 seconds). When the first poll completes you'll see:

  • A version (e.g. "20.0.0").
  • A license type and seat count.
  • A trunk count and which trunks are up/down.
  • A health score out of 100. (It'll be approximate for the first day — the uptime component needs at least one full day of polling history.)

Step 4 — Install the Chrome extension

We strongly recommend installing the Sikurd 3CX Autofill extension right after your first instance is connected. It auto-fills the 3CX login from your Sikurd session whenever you open any of your connected FQDNs.

There's a step in the onboarding wizard for this; you can also click Install extension at the very bottom of the sidebar at any time.

Full walkthrough →

Next

Install the Chrome extension

One click into any of your 3CX consoles.