...
Type | Endpoint | |||||||
---|---|---|---|---|---|---|---|---|
GET | /devices | Return a collection of devices with the default set of columns from the system table (system.system_id, system.icon, system.man_type, system.hostname, system.domain, system.man_ip_address, system.man_description, system.man_os_family, system.man_status) | ||||||
GET | /devices/{id} | Return an individual devices details. | ||||||
GET | /devices?subresourcesub_resource={subresource sub_resource name} | To return all items in a subresource sub_resource 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}?subresourcesub_resource={subresource sub_resource name} | To return all items in a subresource sub_resource for a specific device. | ||||||
GET | /devices?sub_resource={subresource sub_resource name}&sub_resource_id={subresource sub_resource id} | To return a specific item in a subresource sub_resource for a collection of devices - not especially useful. You would more likely use the below (request a subresource sub_resource items from a specific device) | ||||||
GET | /devices{id}?sub_resource={subresource sub_resource name}&sub_resource_id={subresource sub_resource id} | To return a specific subresource sub_resource 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.
|
Device
...
sub_resource Names
NAME | NAME | NAME |
---|---|---|
audit_log | netstat | service |
...