Privilege Cloud system health summary

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

URL

 

https://<subdomain>.privilegecloud.cyberark.com/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 Privilege Cloud Portal, CPM, PSM/PSM for SSH, 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.

  • Privilege Cloud Portal - active users
  • CPM - managed accounts

  • PSM/PSM for SSH - concurrent sessions

  • 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 Privilege Cloud.

Type: Integer

ComponentSpecificStat

Component type specific information:

  • Privilege Cloud Portal- Number of active users
  • CPM- Number of managed accounts

  • PSM/PSM for SSH - Number of concurrent sessions

  • AIM - Number of application IDs

Type: Integer

Return codes

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