Get platform details

This method retrieves details of a specified platform from Privilege Cloud.

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/

 

 
https://<subdomain>.privilegecloud.cyberark.cloud/PasswordVault/API/Platforms/{PlatformName}
/

The following mandatory value is required in the URL:

Parameter

PlatformName

Type

String

Description

The unique ID/Name of the platform.

Resource information

HTTP method

GET

Content type

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

Body parameters

None

Result

 
{
"PlatformID":<Platform ID>
"Properties":<list of key\value>
"Active":<is active>
}

 

Parameter

PlatformID

Type

String

Description

The unique ID of the platform.

Parameter

Properties

Type

List

Description

List of all the parameters with their values from the Policy INI file of specific platform

Parameter

Active

Type

true/false

Description

According to the Master Policy and relevant exception (if it exists).

Return codes

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