Changelog and deprecations
This page lists the versions of each Fundamentum API with their status, the operations that are deprecated, and how to follow changes. Check it before you start a new integration or upgrade an existing one.
API versions
| API | Version | Status | Specification |
|---|---|---|---|
| Public API | v1 | Current. A few operations are deprecated, see below | https://api.fundamentum-iot.com/v1/api/swagger.json |
| Public API | v2 | Current | https://api.fundamentum-iot.com/v2/api/openapi.json |
| Devices API | v3 | Current. Use it for all new work | https://devices.fundamentum-iot.com/api/v3/swagger.json |
| Devices API | v2 | Supported, not deprecated. No new features: shelf devices, provisioning keys, HTTPS telemetry and the registry token endpoint are only in v3 | https://devices.fundamentum-iot.com/api/v2/swagger.json |
| Devices API | v1 | Deprecated. Migrate to v3 | https://devices.fundamentum-iot.com/api/v1/swagger.json |
The Public API v1 and v2 are complementary, not successive: each domain lives in one of them. See Public API.
Deprecated operations
Devices API v1
Every v1 device route is deprecated:
| Deprecated | Use instead (v3) |
|---|---|
POST /api/v1/provision |
POST /api/v3/provision |
POST /api/v1/devices/{serial_number}/states |
Publish states over MQTT, see MQTT topics and message formats |
POST /api/v1/devices/{serial_number}/heartbeat |
Heartbeat over MQTT, or POST /api/v3/projects/{project_id}/regions/{region_id}/registries/{registry_id}/devices/{serial_number}/heartbeat |
POST /api/v1/devices/{serial_number}/commands/{device_command_id} |
Report the command status over MQTT, see MQTT topics and message formats |
v1 addresses a device by serial number alone. v3 addresses it by project, region, registry and serial number. See Devices API v3.
Public API v1
| Deprecated | Use instead |
|---|---|
GET /v1/projects/{projectId}/actions |
GET /v1/projects/{projectId}/registries/{registryId}/actions |
POST /v1/projects/{projectId}/actions |
POST /v1/projects/{projectId}/registries/{registryId}/actions |
PUT /v1/projects/{projectId}/actions/{actionId} |
Cancel or retry the action: actions/{actionId}:cancel, actions/{actionId}:retry |
GET, PUT /v1/projects/{projectId}/device-actions/{deviceActionId} |
GET /v1/projects/{projectId}/devices/{deviceId}/actions, and devices/{deviceId}/actions/{actionId}:cancel or :retry |
GET /v1/projects/{projectId}/registries/{registryId}/device-actions |
GET /v1/projects/{projectId}/registries/{registryId}/actions |
GET, PUT /v1/projects/{projectId}/registries/{registryId}/heartbeats/config |
GET, PUT /v1/projects/{projectId}/device-types/{deviceTypeId}/heartbeats/config |
Deprecated operations still work. They are flagged deprecated: true in the OpenAPI spec, and Swagger UI shows them struck through.
How deprecations are announced
- Deprecated operations are marked
deprecatedin the published OpenAPI specs, with the replacement in their description when there is one. - The
funCLI changes are listed in its changelog at https://cli.fundamentum-iot.com. Runfun check-updateto see whether a newer release is available.
Recent changes
This section will list notable changes to the APIs, the MQTT contract and the fun CLI, newest first.
| Date | Area | Change |
|---|---|---|
| 2026-09 | fun CLI 0.5.3 |
Added the atoms3-lite skill for the AtomS3 Lite starter kit |
| 2026-09 | fun CLI 0.5.2 |
Windows (386) builds published. Added the fun-api-device skill. fun install-skills installs into ~/.claude/skills when ~/.claude exists |
| 2026-09 | fun CLI 0.5.0 |
Added fun install-skills |
| 2026-08 | fun CLI 0.4.0 |
Added fun api (the whole Public API, generated from the specs), shell completion and fun config dir |