Everything EmberCORE does in the browser can be done by your own software. The
console is built on the same API, so anything you can see or change as a person,
an integration can see or change too, with exactly the same rules.
This page covers what the API gives you and who can use each part. When you
are ready to build an integration, talk to us and we will get you started.
Base URL
https://dashboard.embernet.ai/api
On-premises, the base URL is https://<your-embernet-host>/api. The API is part
of EmberCORE itself, so there is no separate API service to install, license, or
monitor.
Some of the routes the tables below describe:
| Route | What it does |
|---|
GET /api/industrial/protocols | Every supported protocol |
GET /api/devices | Your registered devices |
GET /api/alerts | Your alerts, filtered by status, site, or severity |
GET /api/alerts/summary | Alert counts |
POST /api/alerts/acknowledge | Acknowledge an alert |
GET /api/metrics | Cluster metrics |
GET /api/audit/search | Search the audit trail |
Authentication
There are no shared API keys to leak. Every request is made as a person and is
allowed or refused by that person's role in your organization.
- From a browser, requests carry your EmberCORE sign-in. See
SSO Integration.
- From the EmberNet Endpoint client, the
client signs in with your identity provider account and reads the information
it needs about its own organization.
Rate limiting
The API is built for integrations and is not rationed. Fireball only limits the
public access request form, so it cannot be used to flood us with requests.
Tenant scope
Every request is scoped to your organization. Asking for another organization's
data is refused rather than quietly filtered, so a mistake in an integration can
never leak data across the line. Fireball platform staff, working from Global
Command, can see across organizations.
Responses
Responses are plain JSON, and errors come back with a clear status and a short
message.
Access levels
| Level | Who |
|---|
| Any role | Every role in your organization, Viewer included |
| Engineer | Engineers and Admins |
| Admin | Organization Admins |
| Global Command | Fireball platform staff only |
Session and tenants
| What you can do | Access |
|---|
| See who you are, your role, your organization, and what your view shows | Any role |
| List the organizations you belong to | Any role |
| List an organization's members | Admin |
| Check that EmberCORE is up | Public |
Nodes and metrics
| What you can do | Access |
|---|
| List your edge nodes and the apps running on each | Any role |
| Read your organization's headline counts | Any role |
| Follow live node updates as they happen | Any role |
| Read cluster CPU, memory, and disk, node health, and events | Engineer |
Sites and devices
| What you can do | Access |
|---|
| Browse sites, buildings, and their health | Any role |
| Create, edit, and remove sites | Admin |
| List registered devices and run a health check on one | Any role |
| Register, update, and remove devices, and manage their stored credentials | Admin |
| Open a device's own web interface through EmberCORE | Any role |
| Import devices in bulk from a template | Admin |
SNMP
| What you can do | Access |
|---|
| Read a device's SNMP settings, latest metrics, and interface status | Any role |
| Save SNMP settings | Admin |
See SNMP Configuration.
Industrial collectors
| What you can do | Access |
|---|
| List every supported protocol | Any role |
| Read a device's collector configuration, status, and recent tag values with quality | Any role |
| Read a tag's history from the time-series store | Any role |
| Save or stop a collector. A configuration that cannot work is refused with the reason | Admin |
| Fetch your organization's OPC UA client certificate, so your server can trust it ahead of time | Admin |
Every protocol's settings are described in
Device Connectivity.
Alerts
| What you can do | Access |
|---|
| Read your alerts, filtered by status, site, or severity, and their counts | Any role |
| Acknowledge an alert | Any role |
| Resolve an alert | Admin |
| Manage alert rules | Global Command |
An alert carries its severity (critical, warning, or info), its type, a title
and message, its status (active, acknowledged, or resolved), the device, site,
and building it concerns, and when it happened. Alerts come from device and site
rules, from storage health, and from cluster health.
Rules are managed by Fireball, so ask us to add or change one. A rule can ring
the bell in EmberCORE, send email, and post the alert as JSON to a webhook URL
you give us, so your paging or chat tools hear about it. A webhook that fails
is retried before EmberCORE gives up.
Phone alerts
Phone alerts are push notifications for critical alerts. In EmberCORE, the
bell's Phone alerts switch in the Global Command, Admin, and Engineer views
turns them on and sends a test notification right away. Who receives an alert is
decided when it fires: the alert's organization, plus Fireball staff. On iPhone
and iPad, push works from EmberCORE installed to the Home Screen, not from a
Safari tab.
Storage
| What you can do | Access |
|---|
| Read capacity, volume health, disks, backups, snapshots, and scheduled jobs | Admin |
| Run volume actions and change storage settings | Admin |
| Set a backup target and test it before you rely on it | Admin |
See Cinder.
App Store and apps
| What you can do | Access |
|---|
| Browse the catalog you can see | Any role |
| Deploy an app to a node, list your deployments, and remove one | Engineer |
| List your running apps and open their interfaces | Any role |
| Uninstall a running app | Engineer |
AnvilMQ broker
| What you can do | Access |
|---|
| Read broker health for your organization | Engineer |
| Manage your organization's broker users | Admin |
Flux
| What you can do | Access |
|---|
| Read your organization's Flux overview, services, identities, and routers | Any role |
| Read measured latency to each of your services | Any role |
Users
| What you can do | Access |
|---|
| List the users in your organization | Admin |
| Invite a user at any role up to your own | Admin |
| Edit, suspend, restore, or remove a user | Admin |
| See which permissions each role holds | Admin |
Audit
| What you can do | Access |
|---|
| Read the recent activity feed | Operator and above |
| Search your organization's audit log | Admin |
| Export your audit trail to your own S3 storage, Azure Blob storage, PostgreSQL database, or HTTPS endpoint, and run the export on demand | Admin |
| Read how long the audit log is kept | Admin |
| Schedule and run reports | Admin |
Ignition
| What you can do | Access |
|---|
| Read your Ignition gateway's status and setup | Operator and above |
| Manage the gateway accounts EmberCORE signs your people in with, and which Ignition roles each EmberCORE role receives | Admin |
Shells and support
| What you can do | Access |
|---|
| Open a shell on a node or an app your organization owns | Admin |
| Open a support ticket | Any signed-in user |
EmberNet Endpoint
| What you can do | Access |
|---|
| List the endpoints in your organization and their liveness | Signed-in endpoint |
Next steps