...
When using the API the default action is determined according to the format and URL. You can override this by providing the 'action' option in the URL. An example of this is when creating a new item. You would normally use POST to /item but in the case of a web user, you need a web form to be able to fill out the item details. In that case there is no facility for this in a typical JSON restul API. We work around this by providing action=create in a GET request for the URL. IE - http://{server}/open-audit/index.php/networks?action=create.
Sort
To sort by a database column, user "sort={attribute}". To reverse sort, insert a minus, thus "sort=-{attribute}".
| Code Block |
|---|
sort=[-]{attribute} |
Current
By default, only attributes with "current=y" are retrieved. To override this, set current as below.
| Code Block |
|---|
current={y|n|all} |
GroupBy
| Code Block |
|---|
groupby={attribute} |
Limit
When requesting JSON, by default no limit is set.
When requesting screen display, limit is set to 1000 by default.
| Code Block |
|---|
limit={int} |
Offset
The offset is the count of devices you wish to return data from.
| Code Block |
|---|
offset={int} |
Properties
Requested properties should be in a comma separated list.
| Code Block |
|---|
properties={attribute 1},{attribute 2},{attribute 3} |
Filter
To filter by a property value, use the property name. Operators that should preceed the value are !=, >, >=, <, <=, LIKE. If no operator is specified, the default is =.
| Code Block |
|---|
{attribute}=[operator]{value} |
Version
To request a different version of the API (currently only v1 exists), use the attribute 'version'.
| Code Block |
|---|
version=[1] |
End Points
All endpoints URLs are of the format http://{server}/open-audit/index.php/{endpoint}
...
| 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.
|
Device SubResource Names
...