Child pages
  • Devices

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A device in Open-AudIT has an Open-AudIT specific name. This is distinct from its hostname, dns hostname, sysName or any other retrieved attribute. Open-AudIT will populate the name attribute based on the information it has determined about a device. The name can be overwritten by the user at any time. Where possible, the first option will be chosen and where possible on subsequent audits, will be changed to the first option: hostname, sysName, dns_hostname, sysName, IP address.

Creating a Devices Entry

...

The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).

API Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
Example Response
POSTn
createdevices::create/devicesInsert a new (manual) devices entry.
GETy
readdevices::read/devices/{id}Returns a devices details.
PATCHy
updatedevices::update/devices/{id}Update an attribute of a devices entry.
DELETEy
deletedevices::delete/devices/{id}Delete a devices entry.
GETn
collectiondevices::read/devicesReturns a list of devices.
POSTnimportimportdevices::create/devices/importImport multiple devices using a CSV.

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formdevices::create/devices/createDisplays a standard web form for submission to POST /devices.
GETyupdateupdate_formdevices::update/devices/{id}Show the devices details with the option to update attributes using PATCH to /devices/{id}
GETnimportimport_formdevices::create/devices/importDisplays a standard web form for submission to POST /devices/import.