PAS 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: + & %

 

 

https://<IIS_Server_Ip>/PasswordVault/api/ComponentsMonitoringDetails/{ComponentID} 

The following mandatory value is required in the URL:

Parameter

ComponentID

Type

String

Description

The type of component for which data will be retrieved.

Valid values

PVWA/SessionManagement/CPM/AAM Credential Providers

 

https://<IIS_Server_Ip>/api/ComponentsMonitoringDetails/PVWA

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, encoded in BASE 64.

Result

 
{

"ComponentsDetails": [

{

"ComponentIP": "<ComponentIP>",

"ComponentUserName": "<ComponentUserName>",

"ComponentVersion": "<ComponentVersion>,

"ComponentSpecificStat": <details>

"IsLoggedOn": <true/false>,

"LastLogonDate": "<timestamp>"

},

]

}

 

Parameter

ComponentIP

Type

String

Description

The IP of the component server.

Parameter

ComponentUserName

Type

String

Description

The user name of the component, as recognized by the Vault.

Parameter

ComponentVersion

Type

String

Description

The version number of the installed component's instance.

Parameter

ComponentSpecificStat

Type

Integer

Description

Component specific information. Currently this is not supported and will always return '-1'.

Parameter

IsLoggedOn

Type

Boolean

Description

Whether or not the component is connected to the Vault.

Parameter

LastLogonDate

Type

The last date/time when the component logged onto the Vault server.

Description

Date

Return codes

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