...
All endpoints URLs are of the format http://{server}/open-audit/index.php/{endpoint}
NOTE - The below examples use SQL column names from 1.12.6. This are in the process of being revised for our next release.
Devices
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.namehostname, 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?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.
|
...
NAME | NAME | NAME |
---|---|---|
audit_log | netstat | service |
Examples
...
Retrieve all devices with the standard columns:
...