PAM - Self-Hosted system health summary

This method returns consolidated information about the Vault, PVWA, CPM, PSM/PSM for SSH, PTA, and Secrets Manager Credential Providers, including all clients that are relevant to each specific component.

URL

https://<IIS_Server_Ip>/PasswordVault/API/ComponentsMonitoringSummary/

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method	Content type
GET	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

Result

For PVWA, CPM, PSM/PSM for SSH, PTA, and AIM:

{

"Components": [

{

"ComponentID": "<ComponentID>",

"ComponentName": "<ComponentName>",

"Description": "<Description>",

"ConnectedComponentCount": <number>,

"ComponentTotalCount": <number>,,

"ComponentSpecificStat": <number>,

}

]

Parameter	Description
ComponentID	The ID of the component whose details are displayed. Type: String
ComponentName	The name of the component whose details are displayed. Type: String
Description	The type of information that will be displayed based on the relative component. PVWA - active users CPM - managed accounts PSM/PSM for SSH - concurrent sessions PTA - monitored targets AIM - application IDs Type: String
ConnectedComponentsCount	The number of logged on component users for the relative component. Type: Integer
ComponentTotalCount	The total number of component users for the component type in the Vault. Type: Integer
ComponentSpecificStat	Component type specific information: PVWA- Number of active users CPM- Number of managed accounts PSM/PSM for SSH - Number of concurrent sessions PTA- Number of monitored targets AIM - Number of application IDs Type: Integer

For Vaults

"Vaults": [

{

"IP": "<IP>",

"Role": "<Role>",

"IsLoggedOn": <true/false>

}

]

Parameter	Description
IP	The IP of the Vault server. Type: String
Role	The role of the Vault. In on-premise and Primary-DR deployments, one of the following values is displayed: Primary DR In Digital Vault deployments, one of the following values is displayed: Master DR Type: String
IsLoggedOn	Whether or not the component user is currently logged on to the Vault and replicating to the DR Vault. Type: Boolean

Parameter

Description

The IP of the Vault server.

Type: String

Role

The role of the Vault.

In on-premise and Primary-DR deployments, one of the following values is displayed:

Primary
DR

In Digital Vault deployments, one of the following values is displayed:

Master
DR

Type: String

IsLoggedOn

Whether or not the component user is currently logged on to the Vault and replicating to the DR Vault.

Type: Boolean

Return codes

For a complete list of return codes, see Return Codes.