Skip to content

Beam API overview

Understand where the Beam APIs run and how to connect to them.

Updated View as Markdown

MK.IO Beam has cloud APIs for fleet and infrastructure management, and a device-local API for channels. Choose the connection that matches the resources you need to manage.

Cloud APIs

The Fleets and Infrastructure APIs use https://app.mk.io/ with bearer authentication. Requests are scoped to a project:

API Path prefix Guide
Fleets /api/v1/projects/{project_name}/fleet/ Fleet workflows
Infrastructure /api/v1/projects/{project_name}/infra/ Networks and sites

Use the Infrastructure API to define sites and networks for a deployment. Use the Fleets API to register devices, manage software, and back up or restore device configurations.

Start with Authentication and connections, then Your first API call.

Device-local Channels API

The Channels API configures channels on the Beam device. Follow Connect to a Beam device for its connection requirements and How channels work for its resource model.

API references

For organization, project, and token administration, see the Management API guides.

Navigation