MImirurobotics
Device

Sync

Manually force a device sync with the edits made in the dashboard.

post/device/sync

Request

  • Base URL
    http://localhost/v1
  • URL
    http://localhost/v1/device/sync
  • Auth
    none required

Response

Successfully synced the device.

code'success' | 'network_connection_error' | 'in_cooldown' required

The result of attempting to sync the device.

messagestring required

The message of the result.

last_synced_atstring date-time required

Timestamp of when the device was last synced.

last_attempted_sync_atstring date-time required

Timestamp of when the last attempted sync occurred.

in_cooldownboolean required

Whether the device is currently in cooldown.

cooldown_ends_atstring date-time required

Timestamp of when the cooldown will end.

Example response

{
  "code": "in_cooldown",
  "message": "Device is not connected to the backend.",
  "last_synced_at": "2021-01-01T00:00:00Z",
  "last_attempted_sync_at": "2021-01-01T00:00:00Z",
  "in_cooldown": true,
  "cooldown_ends_at": "2021-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.