Dashboard APIs
Get AD Summary (GET)
Returns Active Directory summary statistics for the dashboard.
Route
|
URI |
/api/v1/dashboard/ad |
|
Method |
GET |
|
Result |
JSON – AdSummaryModel |
Parameters
None
Example
GET http://localhost/api/v1/dashboard/ad
{
"$type": "pn.openService.WebApiControllerResponse`1[[pn.openService.adDashboard.ActiveDirectorySummaryData[], pn.openService.interfaces]], pn.openService.interfaces",
"resultIndication": "SuccessWithData",
"data": [
{
"$type": "pn.openService.adDashboard.ActiveDirectorySummaryData, pn.openService.interfaces",
"itemTypeId": "Users",
"itemTypeLocalizedDisplayName": "Users",
"itemTypeCount": 72877,
"parentItemTypeId": "NoParent"
},
{
"$type": "pn.openService.adDashboard.ActiveDirectorySummaryData, pn.openService.interfaces",
"itemTypeId": "DisabledUsers",
"itemTypeLocalizedDisplayName": "Disabled users",
"itemTypeCount": 493,
"parentItemTypeId": "Users"
},
...
]
}
Get Recent Changes (GET)
Returns recent changes from the logbook.
Route
|
URI |
/api/v1/logbook/recent |
|
Method |
GET |
|
Result |
JSON – Array of LogbookEntry |
Parameters
count - Number of recent entries to return (optional)
Example
GET http://localhost/api/v1/logbook/recent?count=50
Get Environment (GET)
Returns environment information for the dashboard.
Route
|
URI |
/api/v1/dashboard/environment |
|
Method |
GET |
|
Result |
JSON – EnvironmentModel |
Parameters
None
Example
GET http://localhost/api/v1/dashboard/environment
{
"$type": "pn.openService.WebApiControllerResponse`1[[pn.openService.adDashboard.EnvironmentSummaryData[], pn.openService.interfaces]], pn.openService.interfaces",
"resultIndication": "SuccessWithData",
"data": [
{
"$type": "pn.openService.adDashboard.EnvironmentSummaryData, pn.openService.interfaces",
"itemTypeId": "Users",
"itemTypeLocalizedDisplayName": "Users",
"itemTypeCount": 72877
},
{
"$type": "pn.openService.adDashboard.EnvironmentSummaryData, pn.openService.interfaces",
"itemTypeId": "Computers",
"itemTypeLocalizedDisplayName": "Computers",
"itemTypeCount": 21087
},
…
]
}
Get Latest Scans (GET)
Returns the latest scan job details.
Route
|
URI |
/api/v1/scanconfiguration/scanjobdetail |
|
Method |
GET |
|
Result |
JSON – Array of ScanJobDetail |
Parameters
None
Example
GET http://localhost/api/v1/scanconfiguration/scanjobdetail
{
"$type": "pn.openService.WebApiControllerResponse`1[[pn.fasels.information.jobs.ScanConfigurationJobDetails[], libInterfaces]], pn.openService.interfaces",
"resultIndication": "SuccessWithData",
"data": [
{
"$type": "pn.fasels.information.jobs.ScanConfigurationJobDetails, libInterfaces",
"resourceId": "f1c4d055-8070-4d6b-99cb-b88f518e8504",
"resourceType": "ActiveDirectory",
"displayName": "protect-net.local",
"startTime": null,
"executionTime": null,
"executionAccountName": null,
"jobResult": "NotExecuted"
},
{
"$type": "pn.fasels.information.jobs.ScanConfigurationJobDetails, libInterfaces",
"resourceId": "e9f74fcd-70ee-4936-b001-28dd991abdf6",
"resourceType": "ActiveDirectory",
"displayName": "eng.protect.local",
"startTime": null,
"executionTime": null,
"executionAccountName": null,
"jobResult": "NotExecuted"
},
…
]
}
Dashboard Scenario Result Summaries (GET)
Returns summary of scenario results for the risk assessment dashboard.
Route
|
URI |
/api/v1/RiskAssessmentDashboard/ScenarioResultSummaries |
|
Method |
GET |
|
Result |
JSON – Array of ScenarioResultSummary |
Parameters
None
Example
GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioResultSummaries
[
{
"Type": "F35677DA-E20E-485F-9DE6-C65338363FC8",
"score": 100.0,
"count": 850,
"totalCount": 72877,
"systemStatus": 2,
"title": "Inactive accounts",
"scenarioId": "0d4713ae-9460-493f-8521-55c65a7f99c6",
"text": null,
"diagram": [
{
"$type": "pn.analyze.client.interfaces.ScenarioDiagramElement, pn.analyze.client.interfaces",
"value": 100.0,
"text": "protected-networks.local",
"affectedCount": 212,
"totalCount": 268,
"totalValue": 212.0,
"totalText": "accounts"
}
]
},
…
]
Dashboard Overall Summary (GET)
Returns overall summary for the risk assessment dashboard.
Route
|
URI |
/api/v1/RiskAssessmentDashboard/OverallSummary |
|
Method |
GET |
|
Result |
JSON – OverallSummaryModel |
Parameters
None
Example
GET http://localhost/api/v1/RiskAssessmentDashboard/OverallSummary
{
"Type": "F35677DA-E20E-485F-9DE6-C65338363FC8",
"score": 100.0,
"count": 0,
"totalCount": 0,
"systemStatus": 2,
"title": null,
"scenarioId": "cbb394f7-c793-4b38-a826-225c818d91d9",
"text": null,
"diagram": null
}
Dashboard Scenario Details (GET)
Returns detailed information for a specific scenario.
Route
|
URI |
/api/v1/RiskAssessmentDashboard/ScenarioDetails/{requestId} |
|
Method |
GET |
|
Result |
JSON – ScenarioDetailsModel |
Parameters
requestId - The scenario request identifier (in URL path)
Example
GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioDetails/123e4567-e89b-12d3-a456-426614174000
Dashboard Scenario Summary (GET)
Returns summary for a specific scenario.
Route
|
URI |
/api/v1/RiskAssessmentDashboard/ScenarioResultSummary/{requestId} |
|
Method |
GET |
|
Result |
JSON – ScenarioResultSummary |
Parameters
requestId - The scenario request identifier (in URL path)
Example
GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioResultSummary/123e4567-e89b-12d3-a456-426614174000
Dashboard Scenario Refresh (POST)
Refreshes scenario data on the dashboard.
Route
|
URI |
/api/v1/RiskAssessmentDashboard/ScenarioDetails/{requestId}/Refresh |
|
Method |
POST |
|
Result |
JSON – RefreshResult |
Parameters
requestId - The scenario request identifier (in URL path)
Example
POST http://localhost/api/v1/RiskAssessmentDashboard/ScenarioDetails/123e4567-e89b-12d3-a456-426614174000/Refresh