...
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 |
|---|---|---|---|---|---|---|---|
| POST | n | create | devices::create | /devices | Insert a new (manual) devices entry. | ||
| GET | y | read | devices::read | /devices/{id} | Returns a devices details. | ||
| PATCH | y | update | devices::update | /devices/{id} | Update an attribute of a devices entry. | ||
| GET | n | collection | devices::read | /devices | Returns a list of devices. | ||
| POST | n | import | import | devices::create | /devices/import | Import multiple devices using a CSV. |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | devices::create | /devices/create | Displays a standard web form for submission to POST /devices. |
| GET | y | update | update_form | devices::update | /devices/{id} | Show the devices details with the option to update attributes using PATCH to /devices/{id} |
| GET | n | import | import_form | devices::create | /devices/import | Displays a standard web form for submission to POST /devices/import. |