No items found.

Runecast API Boost

August 8, 2017

Version 1.5.6.0 of Runecast Analyzer was released on August 7, 2017 delivering bug fixes, KB definitions updates and four times more REST API endpoints. That number jumps from the initial 11 endpoints all the way to 44! Almost all aspects of the product are now covered, including its configuration. This allows for more complete integration, advanced queries for specific issues or objects, filtering, adding/removing vCenter Servers, managing licenses etc. You can test each of them via the swagger interface under Settings -> API Access Tokens -> Runecast API, but since you’re triggering requests against your setup, pay attention to the configuration calls as you can override your settings.

POST request to /api/v1/users/local/{username}/tokens is one of my new favorite endpoints. Having the opportunity to generate access token via REST API allows you to perform configuration of Runecast Analyzer without even logging in to the UI. An excellent example of that is performing unattended deployment and configuration. You can see this in action at TheVirtualist: Unattended Deployment and Configuration of OVA.

Below you can find a summary of the current set of endpoints:

Runecast REST API


Method	Endpoint	Description
Configuration
GET	/api/v1/scheduler/logs	Get log retention settings
PUT	/api/v1/scheduler/logs	Update log retention settings
GET	/api/v1/syslog_config	Get syslog configuration
PATCH	/api/v1/syslog_config	Update syslog config
GET	/api/v1/syslog_config/{vcUid}	Get syslog configuration for the specified vCenter
GET	/api/v1/syslog_config/{vcUid}/{moid}	Get syslog configuration for the specified object
Filters
DELETE	/api/v1/filters	Remove all filters
POST	/api/v1/filters	Add filters
DELETE	/api/v1/filters/{filterId}	Remove a filter
GET	/api/v1/filters/{filterId}	Get info about a filter
PUT	/api/v1/filters/{filterId}	Update a filter
PUT	/api/v1/filters/{filterId}{?enabled}	Enable or disable a filter
GET	/api/v1/filters{?enabled}	Get info about filters
Inventory objects
GET	/api/v1/hosts{?licensed}	Get all hosts
KBs
GET	/api/v1/kbs{?type}	Get KBs used by Runecast
Licensing
DELETE	/api/v1/licenses	Remove all licenses
GET	/api/v1/licenses	Get info about licenses
POST	/api/v1/licenses	Add a license
DELETE	/api/v1/licenses/{licenseId}	Remove a license
PUT	/api/v1/licenses/{licenseId}	Update a license
Results of analysis
GET	/api/v1/results	Get all issues (and their findings) reported in the last scan
GET	/api/v1/results/issues/{issueId}	Get all findings reported in the last scan for the specified issue
GET	/api/v1/results/issues/{issueId}/{vcUid}	Get all findings reported in the last scan for the specified KB and vCenter
GET	/api/v1/results/kbs/{kbId}	Get all findings reported in the last scan for the specified KB
GET	/api/v1/results/kbs/{kbId}/{vcUid}	Get all findings reported in the last scan for the specified KB and vCenter
GET	/api/v1/results/objects/{vcUid}	Get all issues (and their findings) reported in the last scan for the specified vCenter
GET	/api/v1/results/objects/{vcUid}/{moid}	Get all issues reported in the last scan that the specified object contributed to
Scheduled tasks
GET	/api/v1/alerts/email	Get email alerts settings
PUT	/api/v1/alerts/email	Update email alerting settings
PUT	/api/v1/alerts/email{?enabled}	Enable or disable email alerts
GET	/api/v1/scheduler/scan	Get scheduled scan
PUT	/api/v1/scheduler/scan	Update scheduled scan
User accounts
GET	/api/v1/users/ad	Get AD settings
PUT	/api/v1/users/ad	Update Active Directory settings
PUT	/api/v1/users/ad{?enabled}	Enable or disable Active Directory accounts
PUT	/api/v1/users/local/{username}	Update local user
POST	/api/v1/users/local/{username}/tokens	Generate access token for user
vCenters
POST	/api/v1/scan/{vcUid}	Trigger scan of the specified vCenter
GET	/api/v1/scan_status/{vcUid}	Get scan status for the specified vCenter
DELETE	/api/v1/vcenters	Remove all vCenters
GET	/api/v1/vcenters	Get info about vCenters
DELETE	/api/v1/vcenters/{vcUid}	Remove a vCenter
GET	/api/v1/vcenters/{vcUid}	Get info about a vCenter
PUT	/api/v1/vcenters{?async}	Add or update a vCenter