Skip to content

Changelog

Changes to the External API, newest first. Additive changes are listed here as well as breaking ones, so you can tell whether a field you are seeing for the first time is new or was always there.

See Versioning and deprecation for what counts as breaking.

First public release.

Systems

  • GET /systems and GET /systems/{serialNumber}.

Telemetry

  • GET /systems/{serialNumber}/telemetry/latest - connectivity, state of charge, fault and the most recent completed 15-minute interval in one call.
  • GET /systems/{serialNumber}/telemetry/energy - energy per bucket across all input channels and the output channel, at 15m, 1h or 1d.
  • GET /systems/{serialNumber}/telemetry/soc - state of charge per bucket, with average, minimum and maximum.
  • GET /systems/{serialNumber}/health - the latest daily health snapshot.

Alerts

  • GET /alerts and GET /alerts/{id}, with the kinds system.offline, soc.low, system.fault and health.critical.
  • GET and PUT /systems/{serialNumber}/alert-settings for per-system thresholds.

Webhooks

  • Full subscription management, secret rotation, test deliveries and delivery history.
  • Events alert.raised and alert.resolved, plus the implicit webhook.test.
  • Signed with X-CP-Signature (HMAC-SHA256 over the timestamp and the raw body).

Platform

  • API keys with scopes, created in fleet-manager under Settings -> API keys.
  • 600 requests per minute per key.