{ "opencollection": "1.0.0", "info": { "name": "Arduino IoT Cloud binaries_v2 devices_v2 API", "version": "2.0" }, "items": [ { "info": { "name": "devices_v2", "type": "folder" }, "items": [ { "info": { "name": "list devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "across_user_ids", "value": "", "type": "query", "description": "If true, returns all the devices" }, { "name": "serial", "value": "", "type": "query", "description": "Filter by device serial number" }, { "name": "show_deleted", "value": "", "type": "query", "description": "If true, shows the soft deleted devices" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags" }, { "name": "unique_hardware_id", "value": "", "type": "query", "description": "Filter by device unique hardware id" } ] }, "docs": "Returns the list of devices associated to the user" }, { "info": { "name": "create devices_v2", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/iot/v2/devices", "headers": [ { "name": "X-Organization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new device associated to the user." }, { "info": { "name": "createClaimed devices_v2", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/iot/v2/devices/claim", "headers": [ { "name": "X-Organization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new device associated to the user." }, { "info": { "name": "show devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices/:id", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" } ] }, "docs": "Returns the device requested by the user" }, { "info": { "name": "update devices_v2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/iot/v2/devices/:id", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a device associated to the user" }, { "info": { "name": "delete devices_v2", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/iot/v2/devices/:id", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "force", "value": "", "type": "query", "description": "If true, hard delete the device" }, { "name": "id", "value": "", "type": "path", "description": "The id of the device" } ] }, "docs": "Removes a device associated to the user" }, { "info": { "name": "getEvents devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices/:id/events", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" }, { "name": "limit", "value": "", "type": "query", "description": "The number of events to select" }, { "name": "start", "value": "", "type": "query", "description": "The time at which to start selecting events" } ] }, "docs": "GET device events" }, { "info": { "name": "image devices_v2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/iot/v2/devices/:id/image", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns an iso image to be burned into a usb key" }, { "info": { "name": "getProperties devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices/:id/properties", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" }, { "name": "show_deleted", "value": "", "type": "query", "description": "If true, shows the soft deleted properties" } ] }, "docs": "GET device properties" }, { "info": { "name": "updateProperties devices_v2", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/iot/v2/devices/:id/properties", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update device properties last values" }, { "info": { "name": "timeseries devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices/:id/properties/:pid", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" }, { "name": "limit", "value": "", "type": "query", "description": "The number of properties to select" }, { "name": "pid", "value": "", "type": "path", "description": "The id of the property" }, { "name": "start", "value": "", "type": "query", "description": "The time at which to start selecting properties" } ] }, "docs": "GET device properties values in a range of time" }, { "info": { "name": "removeHardwareID devices_v2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/iot/v2/devices/:id/remove-uhwid", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" } ] }, "docs": "Removes the unique hardware id from the device" }, { "info": { "name": "GetStatusEvents devices_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/iot/v2/devices/:id/status", "headers": [ { "name": "X-Organization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the device" }, { "name": "limit", "value": "", "type": "query", "description": "The number of events to select" }, { "name": "start", "value": "", "type": "query", "description": "The time at which to start selecting events" } ] }, "docs": "GET connection status events" } ] } ], "bundled": true }