...
| Type | Endpoint | |||||||
|---|---|---|---|---|---|---|---|---|
| GET | /devices | Return a collection of devices with the default set of columns from the system table (system.id, system.icon, system.type, system.name, system.domain, system.ip, system.description, system.os_family, system.status) | ||||||
| GET | /devices/{id} | Return an individual devices details. | ||||||
| GET | /devices?subresource={subresource name} | To return all items in a subresource for a collection of devices. If you wanted all software you would use http://{server}/open-audit/index.php/devices?sub_resource=software | ||||||
| GET | /devices/{id}?subresource={subresource name} | To return all items in a subresource for a specific device. | ||||||
| GET | /devices?sub_resource={subresource name}&sub_resource_id={subresource id} | To return a specific item in a subresource for a collection of devices - not especially useful. You would more likely use the below (request a subresource items from a specific device) | ||||||
| GET | /devices{id}?sub_resource={subresource name}&sub_resource_id={subresource id} | To return a specific subresource item for a specific device. | ||||||
| POST | PUT | PATCH | /devices/{id} | To update a device attribute. The body of the POST should be JSON formatted using the attribute name 'data'. An example post updating the description is below.
|
...