infrastructure.md
Build with the Infrastructure API
The Infrastructure API defines where Beam devices live and which networks they can reach. Use it to create networks first, then create sites with routes that reference those networks, and finally register devices against those sites through the Fleets API.
API overview
| Detail | Value |
|---|---|
| Base path | /api/v1/projects/{project_name}/infra/ |
| Scope | Project |
| Reference | Infrastructure API reference |
The two core resources
Networks
Networks represent logical network segments. Their status includes:
status.ownerstatus.scope
These are valid sort and filter fields for the network list endpoint.
Sites
Sites represent locations where devices operate. A site can include routes that reference one or more networks, which is why site creation usually comes after network creation.
Typical sequence
- List existing networks and sites.
- Create the networks you need.
- Create sites with routes that reference those networks.
- Register Beam devices to those sites through the Fleets API.
- Remove dependent references before deleting sites or networks.
Common workflow patterns
Set up infrastructure for Beam devices
Guide
- Set up networks and sites: Follow the recommended order for creating and maintaining infrastructure resources.