Skip to main content

API Reference

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:

RouteWhat it does
GET /api/industrial/protocolsEvery supported protocol
GET /api/devicesYour registered devices
GET /api/alertsYour alerts, filtered by status, site, or severity
GET /api/alerts/summaryAlert counts
POST /api/alerts/acknowledgeAcknowledge an alert
GET /api/metricsCluster metrics
GET /api/audit/searchSearch 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​

LevelWho
Any roleEvery role in your organization, Viewer included
EngineerEngineers and Admins
AdminOrganization Admins
Global CommandFireball platform staff only

Session and tenants​

What you can doAccess
See who you are, your role, your organization, and what your view showsAny role
List the organizations you belong toAny role
List an organization's membersAdmin
Check that EmberCORE is upPublic

Nodes and metrics​

What you can doAccess
List your edge nodes and the apps running on eachAny role
Read your organization's headline countsAny role
Follow live node updates as they happenAny role
Read cluster CPU, memory, and disk, node health, and eventsEngineer

Sites and devices​

What you can doAccess
Browse sites, buildings, and their healthAny role
Create, edit, and remove sitesAdmin
List registered devices and run a health check on oneAny role
Register, update, and remove devices, and manage their stored credentialsAdmin
Open a device's own web interface through EmberCOREAny role
Import devices in bulk from a templateAdmin

SNMP​

What you can doAccess
Read a device's SNMP settings, latest metrics, and interface statusAny role
Save SNMP settingsAdmin

See SNMP Configuration.

Industrial collectors​

What you can doAccess
List every supported protocolAny role
Read a device's collector configuration, status, and recent tag values with qualityAny role
Read a tag's history from the time-series storeAny role
Save or stop a collector. A configuration that cannot work is refused with the reasonAdmin
Fetch your organization's OPC UA client certificate, so your server can trust it ahead of timeAdmin

Every protocol's settings are described in Device Connectivity.

Alerts​

What you can doAccess
Read your alerts, filtered by status, site, or severity, and their countsAny role
Acknowledge an alertAny role
Resolve an alertAdmin
Manage alert rulesGlobal 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 doAccess
Read capacity, volume health, disks, backups, snapshots, and scheduled jobsAdmin
Run volume actions and change storage settingsAdmin
Set a backup target and test it before you rely on itAdmin

See Cinder.

App Store and apps​

What you can doAccess
Browse the catalog you can seeAny role
Deploy an app to a node, list your deployments, and remove oneEngineer
List your running apps and open their interfacesAny role
Uninstall a running appEngineer

AnvilMQ broker​

What you can doAccess
Read broker health for your organizationEngineer
Manage your organization's broker usersAdmin

Flux​

What you can doAccess
Read your organization's Flux overview, services, identities, and routersAny role
Read measured latency to each of your servicesAny role

Users​

What you can doAccess
List the users in your organizationAdmin
Invite a user at any role up to your ownAdmin
Edit, suspend, restore, or remove a userAdmin
See which permissions each role holdsAdmin

Audit​

What you can doAccess
Read the recent activity feedOperator and above
Search your organization's audit logAdmin
Export your audit trail to your own S3 storage, Azure Blob storage, PostgreSQL database, or HTTPS endpoint, and run the export on demandAdmin
Read how long the audit log is keptAdmin
Schedule and run reportsAdmin

Ignition​

What you can doAccess
Read your Ignition gateway's status and setupOperator and above
Manage the gateway accounts EmberCORE signs your people in with, and which Ignition roles each EmberCORE role receivesAdmin

Shells and support​

What you can doAccess
Open a shell on a node or an app your organization ownsAdmin
Open a support ticketAny signed-in user

EmberNet Endpoint​

What you can doAccess
List the endpoints in your organization and their livenessSigned-in endpoint

Next steps​