...
The results can be exported by policy or by devices, a CSV file will be generated.
API / Web Access
You can access the /baselines collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
Access is provided as part of a roles permissions. Baselines is a standard resource and can have create, read, update and delete permissions.
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 | baselines::create | /baselines | Insert a new baseline entry. | ||
| GET | y | read | baselines::read | /baselines/{id} | Returns a baseline details. | ||
| PATCH | y | update | baselines::update | /baselines/{id} | Update an attribute of a baseline entry. | ||
| DELETE | y | delete | baselines::delete | /baselines/{id} | Delete a baseline entry. | ||
| GET | n | collection | baselines::read | /baselines | Returns a list of baselines. | ||
| GET | y | results | baselines::read | /baselines/{id}/results | Returns the results of an executed baseline. | ||
| GET | y | execute | execute | baselines::read | /baselines/{id}/execute | Execute (run) a baseline. |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | baselines::create | /baselines/create | Displays a standard web form for submission to POST /summaries. |
| GET | y | update | update_form | baselines::update | /baselines/{id}/update | Show the baseline details with the option to update attributes using PATCH to /summaries/{id} |
| GET | n | import | import_form | baselines::create | /baselines/import | Displays a standard web form for submission to POST /summaries/import. |
...
Baselines do not at this time support the JSON API. This will be enabled in a future release.