...
The API is using our new model of access. Instead of a user <-> group model, we're using user <-> organisation. If you're having trouble at this early stage, just use the 'administrator' or 'open-audit_enterprise' account(s).
The Endpoints
At present we have endpoints for:
...
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}
...
NAME | NAME | NAME |
---|---|---|
audit_log | netstat | service |
Examples
NOTE - The below examples use SQL column names from 1.12.6. This are in the process of being revised for our next release.
Retrieve all devices with the standard columns:
Code Block |
---|
GET http://{server}/open-audit/index.php/devices |
Retrieve all devices running Windows.
Code Block |
---|
GET http://{server}/open-audit/index.php/devices?os_group=Windows |
Retrieve the first 10 devices running Windows ordered by hostname
Code Block |
---|
GET http://{server}/open-audit/index.php/devices?os_group=Windows&limit=10&sort=hostname |
Retrieve the properties id, ip, hostname, domain, type from all devices
Code Block |
---|
GET http://{server}/open-audit/index.php/devices?properties=system_id,man_ip_address,hostname,domain,man_type |
Networks
Orgs