PAM system health summary
This method returns consolidated information about the
URL
Make sure there are no spaces in the URL. The following characters are not supported in URL values: + & % |
|
|
Resource information
HTTP method |
GET |
Content type |
application/json |
Header parameter
Parameter |
Authorization |
Type |
String |
Description |
The token that identifies the session. |
Valid values |
A session token that was returned from the “Logon” method, . |
Result
For PVWA, CPM, PSM/PSM for SSH,
|
Parameter |
ComponentID |
Type |
String |
Description |
The ID of the component whose details are displayed. |
Parameter |
ComponentName |
Type |
String |
Description |
The name of the component whose details are displayed. |
Parameter |
Description |
Type |
String |
Description |
The type of information that will be displayed based on the relative component.
|
Parameter |
ConnectedComponentsCount |
Type |
The number of logged on component users for the relative component. |
Description |
Integer |
Parameter |
ComponentTotalCount |
Type |
Integer |
Description |
The total number of component users for the component type in the Vault. |
Parameter |
ComponentSpecificStat |
Type |
Integer |
Description |
Component type specific information:
|
For Vaults:
"Vaults": [ |
Parameter |
IP |
Type |
String |
Description |
The IP of the Vault server. |
Parameter |
Role |
Type |
String |
Description |
The role of the Vault. In on-premise and primary-DR deployments, one of the following values is displayed:
In Distributed Vault deployments, one of the following values is displayed:
|
Parameter |
IsLoggedOn |
Type |
Boolean |
Description |
Whether or not the component user is currently logged on to the Vault and replicating to the DR Vault. |
Return codes
For a complete list of return codes, see Return Codes.