Child pages
  • The Open-AudIT API
Skip to end of metadata
Go to start of metadata

Introduction

Open-AudIT has a JSON Restful API to be used both in the web interface and via JSON requests.

Open-AudIT's API

Open-AudIT is basing its API on http://jsonapi.org with the intention of providing simple and intuitive access in a manner familiar to developers.

In addition to this API, the web interface will use the same request format and supply some additional actions.

 

Access Model

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). We have not created the GUI screens to associate a user to an organisation as yet. If you wish to use another account you could run the below SQL directly to create the association:

Where your new $user_id and $org_id can be found in the Open-AudIT web interface.

 

The API uses a cookie. You can request a cookie by sending a POST to the URL below, containing the username and password attributes and values:

POSTing data

To create a resource, you should POST the required data. The format of your data shoudl be in the form:

data[attributes][ATTRIBUTE_NAME]

You should substitute the required column (eg, org_id) for ATTRIBUTE_NAME.

In the case where we store several fields (usually in JSON format) inside a BIGTEXT MySQL field (eg: credentials.credentials - the credentials column in the credentials table), you should use the format:

data[attributes][credentials][credentials][username]

Examples at the bottom of this page.

All endpoints also have a minimum list of required fields. These are:

attributes -   'name', 'org_id', 'type', 'resource', 'value'
collectors - 'name', 'org_id', 'status'
connections - 'name', 'org_id'
credentials - 'name', 'org_id', 'type', 'credentials'
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'

The Endpoints

At present we have endpoints for nearly every collection. They are listed here - Collections.

Options

Format

Using the format option is useful when using a web browser but you wish to see the result in JSON format. Adding format=json achieves this. Normally a web browser will set its accept header to HTML, so in that case, we return the rendered page. Using an API to retrieve JSON you should set the accept header to "json/application". You can override this by providing the format option in the URL.

We tend to use the Google Chrome extension called Postman for testing actual restful queries. You might like to install and test with that. http://www.getpostman.com.

Action

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 Restful API. We work around this by providing action=create in a GET request for the URL. IE - http://{server}/omk/open-audit/networks?action=create. The default action if nothing matches below is to return a collection of items.

API Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
POSTn create{collection}::create/{collection}Insert a new {collection} entry.
GETy read{collection}::read/{collection}/{id}Returns a {collection} details.
PATCHy update{collection}::update/{collection}/{id}Update an attribute of a {collection} entry.
DELETEy delete{collection}::delete/{collection}/{id}Delete a {collection} entry.
GETn collection{collection}::read/{collection}Returns a list of {collection}.

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_form{collection}::create/{collection}/createDisplays a standard web form for submission to POST /{collection}.
GETyupdateupdate_form{collection}::update/{collection}/{id}/updateShow the script details with the option to update attributes using PATCH to /{collection}/{id}
GETnimportimport_form{collection}::create/{collection}/importDisplays a standard web form for submission to POST /{collection}/import.
POSTnimportimport{collection}::create/{collection}/importImport multiple {collection} using a CSV.

 

 

 

Sort

To sort by a database column, user "sort={attribute}". To reverse sort, insert a minus, thus "sort=-{attribute}".

Current

By default, only attributes with "current=y" are retrieved. To override this, set current as below.

GroupBy

Limit

When requesting JSON, by default no limit is set.

When requesting screen display, the limit is set to 1000 by default.

Offset

The offset is the count of devices you wish to return data from.

Properties

Requested properties should be in a comma-separated list. Properties should be fully qualified - ie, system.hostname (not just hostname).

You can also specify properties using the below format.

 

Filter

To filter by a property value, use the property name. Operators that should precede the value are !=, >, >=, <, <=, 'like' and '!like'. If no operator is specified, the default is =. Properties should be fully qualified - ie, system.hostname (not just hostname).

End Points

All endpoints URLs are of the format http://{server}/omk/open-audit/{endpoint}

Devices

TypeEndpoint  
GET/devicesReturn 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

NAMENAMENAME

audit_log
bios
change_log
credentials
disk
dns
edit_log
ip
log
memory
module
monitor
motherboard

netstat
network
optical
pagefile
partition
print_queue
processor
route
san
scsi
server
server_item 

service
share
software
software_key
sound
task
user
user_group
variable
video
vm
windows

Examples

Retrieve all devices with the standard columns:

Retrieve all devices running Windows.

Retrieve the first 10 devices running Windows ordered by hostname

Retrieve the properties id, ip, hostname, domain, type from all devices

Retrieve all details about the device with id 88.

Retrieve a list of devices in the 192.168.1.0/24 subnet

Retrieve a list of devices with OS Name like Windows 2008

 

CURL Examples

Logging in

Creating Credentials

Retrieving a List of Credentials