Child pages
  • Baselines

Versions Compared

Key

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

...

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
POSTn createbaselines::create/baselinesInsert a new baseline entry. 
GETy readbaselines::read/baselines/{id}Returns a baseline details. 
PATCHy updatebaselines::update/baselines/{id}Update an attribute of a baseline entry. 
DELETEy deletebaselines::delete/baselines/{id}Delete a baseline entry. 
GETn collectionbaselines::read/baselinesReturns a list of baselines. 
GETy resultsbaselines::read/baselines/{id}/resultsReturns the results of an executed baseline. 
GETyexecuteexecutebaselines::read/baselines/{id}/executeExecute (run) a baseline. 

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formbaselines::create/baselines/createDisplays a standard web form for submission to POST /summaries.
GETyupdateupdate_formbaselines::update/baselines/{id}/updateShow the baseline details with the option to update attributes using PATCH to /summaries/{id}
GETnimportimport_formbaselines::create/baselines/importDisplays 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.