POST
/
config_instances
/
{config_instance_id}
/
approve
Python
from miru_server_sdk import Miru

client = Miru(
    api_key="My API Key",
)
config_instance = client.config_instances.approve(
    config_instance_id="cfg_inst_123",
    message="The config instance has been approved",
)
print(config_instance.id)
{
  "object": "config_instance",
  "id": "cfg_inst_123",
  "target_status": "created",
  "activity_status": "created",
  "error_status": "none",
  "status": "created",
  "relative_filepath": "/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "device_id": "dvc_123",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_type_123",
  "device": null,
  "config_schema": null,
  "config_type": null,
  "content": {
    "enable_autonomy": true,
    "enable_remote_control": false,
    "max_payload_kg": 8.5,
    "preferred_speed_mode": "normal",
    "emergency_stop_sensitivity": 0.9,
    "telemetry": {
      "upload_interval_sec": 45,
      "heartbeat_interval_sec": 15
    }
  }
}

Authorizations

X-API-Key
string
header
required

The API key to use for authentication. Retrieve your API key from the Miru dashboard.

Path Parameters

config_instance_id
string
required

The unique identifier of the config instance

Example:

"cfg_inst_123"

Query Parameters

expand[]
enum<string>[]

The fields to expand in the config instance

Body

application/json

Response

200 - application/json

Successfully approved the config instance for deployment.

The response is of type object.