Devices¶
List, Searching and Sync of devices are done through the /v1/devices
List Devices¶
Return a list of Devices. Some filtering is possible by passing in filters with the request. .. NOTE:
Request format: GET /v1/devices?{filters}
where filters can be combination of keys: node_id, podm_id, state,
type, pooled_group_id, resource_uri.
For example: GET /v1/devices?node_id=0x000000&type=SSD
By default, this query will return all devices with uuid, podm_id, type, state, node_id, resource_uri and pooled_group_id.
Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request¶
Response¶
Example list of Devices:
Display Device Details¶
Shows details for a Device. This will return the full representation of the device.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request¶
Response¶
Example JSON representation of a Device:
Sync Devices¶
Sync all devices managed with podmanager.
Synchronization of devices connected to one podmanager is possible by
passing podm_id in the body of POST request.
By default it will sync devices connected to all podmanagers one by one.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request¶
Response¶
Example JSON representation of a Sync response: