API reference
Each Profinity REST API has its own page, and the first sentence of a page names the group that Swagger shows for it on your instance. A page lists the endpoints of one API, the permission each needs, and the fields each takes. Swagger on your instance lists every parameter and response field, and the Permission column on each page names the permission an account needs, as described in Roles and permissions. Refer to Authenticate to the Profinity REST API for how to get a token, and to Read real-time and historical tag data for the tag query set endpoints and the endpoints that read one tag or signal.
Sign in
- Users API: sign in, renew a token, and reset an account.
Tags and alerts
- Tags API: read the tag tree, as nested JSON or a paged list.
- Tag history API: read stored tag history.
- Alerts API: list alerts, and acknowledge or silence them.
- Tag rules API: read and save tag rules.
- Tag collections API: read, save and delete tag collections.
- Derived tags API: read, save and check derived tags.
- Tag expressions API: check an expression and preview the tags it matches.
Profiles and components
- Profiles API: list, create, delete, import and export profiles.
- Active profile API: switch the active profile, read its configuration, add, configure and remove its components, and upload their files.
- UI API: read the dashboard schema, and save a profile or component dashboard.
CAN bus and DBC
- CAN bus API: read CAN traffic, send packets, and replay CAN logs.
- DBC API: read the CAN database messages and signals of each component.
Run actions
- Actions API: run component and system actions.