from miru_server_sdk import Miru
client = Miru(
api_key="My API Key",
)
release = client.releases.retrieve(
release_id="rls_123",
)
print(release.id){
"object": "release",
"id": "rls_123",
"version": "v1.0.0",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"config_schemas": []
}Get
Retrieve a release by ID.
from miru_server_sdk import Miru
client = Miru(
api_key="My API Key",
)
release = client.releases.retrieve(
release_id="rls_123",
)
print(release.id){
"object": "release",
"id": "rls_123",
"version": "v1.0.0",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"config_schemas": []
}Authorizations
The API key to use for authentication. Retrieve your API key from the Miru dashboard.
Path Parameters
The unique identifier of the release.
"rls_123"
Query Parameters
The fields to expand in the releases.
config_schemas Response
Successfully retrieved the release.
release "release"
ID of the release.
"rls_123"
The version of the release.
"v1.0.0"
Timestamp of when the release was created.
"2024-01-01T00:00:00Z"
Timestamp of when the release was last updated.
"2024-01-01T00:00:00Z"
Expand the config schemas using 'expand[]=config_schemas' in the query string.
Hide child attributes
Hide child attributes
config_schema "config_schema"
ID of the config schema.
"cfg_sch_123"
Config schema version for the config type.
2
Hash of the config schema contents.
"1234567890"
The file path to deploy the config instance relative to /srv/miru/config_instances. v1/motion-control.json would deploy to /srv/miru/config_instances/v1/motion-control.json.
"/v1/motion-control.json"
Timestamp of when the config schema was created.
"2021-01-01T00:00:00Z"
Timestamp of when the config schema was last updated.
"2021-01-01T00:00:00Z"
ID of the config type.
"cfg_typ_123"
The config schema's JSON Schema definition.
{
"title": "Robot Features",
"type": "object",
"properties": {
"enable_autonomy": { "type": "boolean", "default": true },
"enable_remote_control": { "type": "boolean", "default": true },
"max_payload_kg": {
"type": "number",
"minimum": 0,
"maximum": 99,
"default": 10
},
"preferred_speed_mode": {
"type": "string",
"enum": ["slow", "normal", "fast"],
"default": "normal"
},
"emergency_stop_sensitivity": {
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0.8
},
"telemetry": {
"type": "object",
"properties": {
"upload_interval_sec": {
"type": "integer",
"minimum": 10,
"maximum": 600,
"default": 60
},
"heartbeat_interval_sec": {
"type": "integer",
"minimum": 1,
"maximum": 60,
"default": 10
}
},
"required": [
"upload_interval_sec",
"heartbeat_interval_sec"
]
}
},
"required": [
"enable_autonomy",
"enable_remote_control",
"max_payload_kg",
"preferred_speed_mode",
"emergency_stop_sensitivity",
"telemetry"
]
}Expand the config type using 'expand[]=config_type' in the query string.
Hide child attributes
Hide child attributes
config_type "config_type"
ID of the config type.
"cfg_123"
Name of the config type.
"My Config Type"
An immutable, code-friendly name for the config type.
"my-config-type"
Timestamp of when the config type was created.
"2021-01-01T00:00:00Z"
Timestamp of when the config type was last updated.
"2021-01-01T00:00:00Z"
null
[]