POST
/
config_instances
/
{config_instance_id}
/
deploy
Deploy
curl --request POST \
  --url https://{host}/{version}/config_instances/{config_instance_id}/deploy \
  --header 'X-API-Key: <api-key>'
{
  "deploy": {
    "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
      }
    }
  },
  "remove": [
    {
      "code": "device_file_path_conflict",
      "explanation": "Config instance cfg_inst_123 has the same device and file path as cfg_inst_456",
      "config_instance": {
        "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

​
dry_run
boolean
default:false

Perform a dry run that simulates the operation without making actual changes

Response

200 - application/json

Successfully queued the config instance for deployment and queued conflicting config instances for removal.

The response is of type object.