API
Connect Powoflow to your own systems
A REST API with JSON, and API keys an administrator creates for the workspace. Read-only on Free, read and write on Starter and above.
What you can do
Version 1 of the API, under /v1. Every endpoint is listed below.
Assets and sites
List your assets and sites, and read one asset in full.
Sensor readings
Read a sensor's latest value, or its readings over a time range.
Alarms
Read active alarms, a summary, one alarm, or an asset's alarms.
Work orders
List and read work orders, create them from another system, and add comments.
API keys
Made by an administrator
Create and revoke keys in Settings. A key is shown once and stored only as a hash.
Scoped to your workspace
A key reaches your workspace's data and nothing else.
Read-only or read and write
Read-only on Free. Read and write on Starter and above.
Every key is accounted for
Creating or revoking a key is recorded in the activity log.
Endpoints
Twelve endpoints. An API key reaches these and nothing else.
| GET | /v1/resources | List your assets and sites |
| GET | /v1/resources/{resourceId} | Read one asset in full |
| GET | /v1/resources/{resourceId}/telemetry | A sensor's readings over a time range |
| GET | /v1/resources/{resourceId}/telemetry/latest | A sensor's latest reading |
| GET | /v1/resources/{resourceId}/alarms | One asset's alarms |
| GET | /v1/alarms/active | Active alarms |
| GET | /v1/alarms/summary | A summary of your alarms |
| GET | /v1/alarms/{alarmId} | Read one alarm |
| GET | /v1/work-orders | List work orders |
| GET | /v1/work-orders/{woId} | Read one work order |
| POST | /v1/work-orders | Create a work order (read and write keys) |
| POST | /v1/work-orders/{woId}/comments | Comment on a work order (read and write keys) |