Get safes by platform ID

This method returns Safes according to the platform ID.

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.com/PasswordVault/API/Platforms/{PlatformID}/Safes/

URL parameters

Parameter

Description

PlatformID (mandatory)

The ID of the platform for which you want to return safes.

Type: string

safeName

You can search for a safe using a partial string.

Example:

https://<IIS_Server_Ip>/PasswordVault/api/Platforms/{PlatformID}/Safes?Safe=<safeName>/

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

Parameter

Description

SafeName

A list of safe names.

Type: string

 

  
{

"value":

[
"safe1",

"safe2",

"safe3"

],
"count": <number of returned safes>
}

Return codes

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