...
All endpoints also have a minimum list of required fields. These are:
applications - 'name', 'org_id'
attributes - 'name', 'org_id', 'type', 'resource', 'value'
collectors - 'name', 'org_id', 'status'
configuration - 'value'
connections - 'name', 'org_id'
credentials - 'name', 'org_id', 'type', 'credentials'
dashboards - 'name', 'options'
discoveries - 'name', 'org_id', 'type', 'network_address', 'other'
fields - 'name', 'org_id', 'type', 'placement', 'group_id'
files - 'name', 'org_id', 'path'
groups - 'name', 'org_id', 'sql'
ldap_servers - 'name', 'org_id', 'lang', 'host', 'port', 'secure', 'domain', 'type', 'version', 'use_roles', 'refresh'
licenses - 'name', 'org_id', 'org_descendants', 'purchase_count', 'match_string'
locations - 'name', 'org_id'
networks - 'name', 'org_id', 'network'
orgs - 'name', 'parent_id'
queries - 'name', 'org_id', 'sql', 'menu_category', 'menu_display'
roles - 'name', 'permissions'
scripts - 'name', 'org_id', 'options', 'based_on'
summaries - 'name', 'org_id', 'table', 'column', 'menu_category'
tasks - 'name', 'org_id', 'type', 'sub_resource_id', 'uuid', 'enabled', 'minute', 'hour', 'day_of_month', 'month', 'day_of_week'
users - 'name', 'org_id', 'lang', 'active', 'roles', 'orgs'
widgets - 'name', 'org_id', 'type'
The Endpoints
At present we have endpoints for nearly every collection. They are listed here - Collections.
...
All endpoints URLs are of the format http://{server}/omk/open-audit/{endpoint}
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.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?sub_resource={sub_resource name} | To return all items in a 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}?sub_resource={sub_resource name} | To return all items in a sub_resource for a specific device. | |
| GET | /devices?sub_resource={sub_resource name}&sub_resource_id={sub_resource id} | To return a specific item in a sub_resource for a collection of devices - not especially useful. You would more likely use the below (request a sub_resource items from a specific device) | |
| GET | /devices{id}?sub_resource={sub_resource name}&sub_resource_id={sub_resource id} | To return a specific sub_resource item for a specific device. |
Device sub_resource Names
| NAME | NAME | NAME |
|---|---|---|
audit_log | netstatitem item | service |
Examples
Retrieve all devices with the standard columns:
...