PAM - Self-Hosted system health details
This method returns details about specific components and all their installed instances, and system health information for each one.
URL
|
|
-
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 |
URL parameter
https://<IIS_Server_Ip>/api/ComponentsMonitoringDetails/PVWA |
Parameter |
Description |
---|---|
ComponentId |
The type of component for which data is retrieved. Type: String Mandatory: Yes Valid values:
|
Result
|
Parameter |
Description |
||
---|---|---|---|
ComponentIP |
The IP of the component server. Type: String |
||
ComponentUserName |
The user name of the component, as recognized by the Vault. Type: String |
||
ComponentVersion |
The version number of the installed component's instance. Type: String |
||
ComponentSpecificStat |
Component specific information.
Type: Integer |
||
IsLoggedOn |
Whether or not the component is connected to the Vault. Type: Boolean |
||
LastLogonDate |
The last date/time when the component logged on to the Vault server. Type: Date/Time |
Return codes
For a complete list of return codes, see Return Codes.