2026-10-29.everglades
October 29, 2026 Thiseverglades update adds read access to calibrations. Devices report calibrations starting with Miru Agent v0.12.0. Devices now report the operating system, CPU architecture, hostname, and kernel they run, and releases gain a free-form description.
Every change is additive. 2026-08-17.everglades remains a supported Miru-Version value, so existing integrations keep working without changes.
New endpoints
Calibrations have their ownread and manage scopes.
Additive changes
Migration steps
1
Update the Miru-Version header
Optionally set
Miru-Version: 2026-10-29.everglades on API requests. Requests that send 2026-08-17.everglades keep working. Python SDK v0.13.0 marks the rollout of the 2026-10-29.everglades API. For the latest SDK version compatibility information, visit the Platform SDKs page.2
Handle the csv instance format
If your code branches on config schema
instance_format or config instance content format, handle the new csv value.3
Optionally integrate new endpoints
Optionally integrate the new calibration endpoints listed above, and grant your API keys the scopes they need.
4
Optionally adopt new additive surface
Optionally integrate the new additive API changes listed above.
2026-08-17.everglades
August 17, 2026 Theeverglades release introduces device groups, allowing you to build your fleet hierarchy via API and access device group information. Groups themselves are fully manageable: create, rename, and move them as desired. A device’s membership in a group is read-only, so assigning a device to a group remains a dashboard flow.
everglades also brings the Platform API up to date with three months of configuration changes: config schemas now support instance slots, deployments report more timestamps (queued, deployed, archived), and devices report an archived status.
New endpoints
Breaking changes
Additive changes
Migration steps
1
Update the Miru-Version header
Set
Miru-Version: 2026-08-17.everglades on all API requests. Python SDK v0.11.0 marks the major version rollout of the 2026-08-17.everglades API. For the latest SDK version compatibility information, visit the Platform SDKs page.2
Migrate from config schemas to use instance slots
Replace reads of
instance_filepath with instance_slots[].filepath, and replace instance_filepath in POST /config_schemas request bodies with an explicit instance_slots array. Omitting instance_slots makes the server derive a default filepath rather than reuse your previous one. See instance slots.3
Stop sending slug when updating a config type
Remove
slug from PATCH /config_types/{config_type_id} request bodies. Config type slugs are immutable.4
Review parent_id when creating deployments
No change is needed if you already omit
parent_id or always send a deployment ID. Send null only to assert that the device has no current target deployment.5
Optionally integrate new endpoints
Optionally integrate the new group endpoints listed above.
6
Optionally adopt new additive surface
Optionally integrate the new additive API changes listed above.
2026-05-06.rainier
May 12, 2026 Therainier release introduces a provisioning-token flow that replaces the activation-token endpoint, expands supported config-instance content formats, restores the removing deployment status, and adds expandable current_release / current_deployment fields on devices.
New endpoints
Breaking changes
Additive changes
Migration steps
1
Update the Miru-Version header
Set
Miru-Version: 2026-05-06.rainier on all API requests. Python SDK v0.10.0 marks the major version rollout of the 2026-05-06.rainier API. For the latest SDK version compatibility information, visit the Platform SDKs page.2
Migrate from activation tokens to provisioning tokens
Migrate install workflows to use provisioning tokens instead of activation tokens.
3
Optionally adopt new additive surface
- Handle
yamlcontent format where needed - Handle
removingdeployment status or activity status where needed. - Implement or migrate to
expand=current_releaseand/orexpand=current_deploymentfor retrieving the current release or deployment on a device.
2026-03-09.tetons
March 13, 2026 Thetetons release introduces API versioning and overhauls the representation of deployments, config instances, and config schemas. It introduces management of more configuration resources (config types, schemas, and instances), release creation, git commit tracking, and explicit deployment lifecycle actions.
New endpoints
Breaking changes
Additive changes
Python SDK
Beginning with the2026-03-09.tetons release, the Python SDK is published from python-platform-sdk and uses the miru_platform_sdk import path.
miru_server_sdk import path.
Furthermore, SDK v0.7.0 marks the major version rollout of the 2026-03-09.tetons API. For the latest SDK version compatibility information, see the Platform SDKs page.
Migration steps
1
Set the Miru-Version header
Set the
Miru-Version: 2026-03-09.tetons header on all API requests. If you are using the Python SDK, this is done automatically.2
Migrate breaking changes
Migrate your client application according to the breaking changes listed above.If you are using the Python SDK, migrate from the legacy repository python-server-sdk to python-platform-sdk and update imports from
miru_server_sdk to miru_platform_sdk.3
Optionally integrate new endpoints
Optionally integrate the new endpoints listed above.
2025-10-21.zion
October 21, 2025The
2025-10-21.zion API version is no longer supported. See supported versions.Endpoints
Query parameters
Python SDK
2025-10-21.zion comes with an official Python SDK published to python-server-sdk. For more details on usage, visit the python-server-sdk repository.
The python-server-sdk repository is no longer supported. Please migrate to the python-platform-sdk repository for the latest version of the Platform API.