\FotaApi

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
clear_firmware_error	DELETE /span/collections/{collectionId}/devices/{deviceId}/fwerror	Clear FOTA error
create_firmware	POST /span/collections/{collectionId}/firmware	Create firmware
delete_firmware	DELETE /span/collections/{collectionId}/firmware/{imageId}	Delete firmware
firmware_usage	GET /span/collections/{collectionId}/firmware/{imageId}/usage	Firmware usage
list_firmware	GET /span/collections/{collectionId}/firmware	List firmware
retrieve_firmware	GET /span/collections/{collectionId}/firmware/{imageId}	Retrieve firmware
retrieve_firmware_stats	GET /span/collections/{collectionId}/firmware/{imageId}/stats	Retrieve firmware statistics
update_firmware	PATCH /span/collections/{existingCollectionId}/firmware/{imageId}	Update firmware

clear_firmware_error

crate::models::ClearFirmwareErrorResponse clear_firmware_error(collection_id, device_id) Clear FOTA error

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
device_id	String		[required]

Return type

crate::models::ClearFirmwareErrorResponse

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_firmware

crate::models::Firmware create_firmware(collection_id, body) Create firmware

Firmware images must have unique version numbers and have an unique checksum. The checksum is calculated when the firmware image is uploaded.

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
body	CreateFirmwareBody		[required]

Return type

crate::models::Firmware

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_firmware

crate::models::Firmware delete_firmware(collection_id, image_id) Delete firmware

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
image_id	String		[required]

Return type

crate::models::Firmware

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

firmware_usage

crate::models::FirmwareUsageResponse firmware_usage(collection_id, image_id) Firmware usage

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
image_id	String		[required]

Return type

crate::models::FirmwareUsageResponse

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_firmware

crate::models::ListFirmwareResponse list_firmware(collection_id) List firmware

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]

Return type

crate::models::ListFirmwareResponse

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_firmware

crate::models::Firmware retrieve_firmware(collection_id, image_id) Retrieve firmware

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
image_id	String		[required]

Return type

crate::models::Firmware

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_firmware_stats

crate::models::FirmwareStats retrieve_firmware_stats(collection_id, image_id) Retrieve firmware statistics

Parameters

Name	Type	Description	Required	Notes
collection_id	String		[required]
image_id	String		[required]

Return type

crate::models::FirmwareStats

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_firmware

crate::models::Firmware update_firmware(existing_collection_id, image_id, body) Update firmware

Only the version and tags fields can be updated. The other fields will be ignored.

Parameters

Name	Type	Description	Required	Notes
existing_collection_id	String		[required]
image_id	String		[required]
body	UpdateFirmwareBody		[required]

Return type

crate::models::Firmware

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]