Skip to Content
Bolt DevicesBolt Device API

Bolt Device API

The Bolt Device API lets you list the devices registered to your merchant account, read one, rename it, or run a health check on it. The following operations are available:

  • List Bolt Devices (GET /api/v1/bolt-devices): list your registered devices, newest first.
  • Get Bolt Device by ID (GET /api/v1/bolt-devices/{boltDeviceId}): read one device and its latest metric.
  • Rename Bolt Device by ID (PATCH /api/v1/bolt-devices/{boltDeviceId}/name): change the device label.
  • Health Check Bolt Device by ID (POST /api/v1/bolt-devices/{boltDeviceId}/health-check): ask the device to report on itself. The call is asynchronous and returns 202 Accepted.

For what a device holds, see Bolt Device. For how a health check works and how to read the result, see Device health. For request and response shapes, see the Bolt Device API Specification. For the errors these endpoints return, see Error Handling.

Last updated on
Bolt DeviceBolt Intent