get
https://{url}/v1/devices//files/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use the hub_url received in the registration response as your base URL.
This API requires the device to authenticate, see Device Authentication.
Xyte allows manufacturers to attach various types of files to different device models (firmware, manuals, etc.). Using this API, a device can get information about a single file attached to its model by the manufacturer.
Return Data
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID for this device file |
| name | string | Unique name for this file |
| url | string | Storage URL for this file |
| desc | string | Description for this file |
| file_type | string | Type/category of the file |
| version | string | Version of this configuration |
| checksum | string | Optional checksum field provided during file upload |
| signature | string | Optional signature field provided during file upload |
| created_at | datetime | Date & time when this file was created |
| public_notes | string | Information about the file shown to the End User. |
Return Sample
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "foo 1",
"url": "https://s3.amazonaws.com/myfile.txt",
"desc": "Foo test",
"file_type": "firmware",
"version": "1.0.1",
"created_at": "2022-08-11T14:38:36.930Z"
}When uploading firmware files on the partner's side, the version must be in SemVer format. Non-firmware files and files uploaded directly by organizations do not have this requirement.