Skip to Content
Bolt ConnectionsBolt Connection API

Bolt Connection API

The Bolt Connection API lets you connect your server to a Beam Bolt device for Pairing Mode. The following operations are available:

  • Create Bolt Connection (POST /api/v1/bolt-connections): connect your server to a device using its pairing code.
  • Get Bolt Connection by ID (GET /api/v1/bolt-connections/{boltConnectionId}): check that the connection is still valid.
  • Delete Bolt Connection by ID (DELETE /api/v1/bolt-connections/{boltConnectionId}): disconnect your server from the device.

A Bolt Connection cannot be modified after it is created. Delete it and create a new one instead.

For request and response shapes, see the Bolt Connection API Specification. For the connect and disconnect flows with example requests, see the Pairing Mode guide. For the errors these endpoints return, see Error Handling.

Last updated on
Bolt ConnectionCard Tokenization