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
Section titled “API overview”| Detail | Value |
|---|---|
| Base path | /api/v1/projects/{project_name}/infra/ |
| Scope | Project |
| Reference | Infrastructure API reference |
The two core resources
Section titled “The two core resources”Networks
Section titled “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 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
Section titled “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.