Connectors
...
Actions
Get All Safes
4 min
description retrieve all accessible safes within the cyberark vault based on user permissions endpoint url /passwordvault/api/safes/ method get inputs parameters (object) search (string) searches according to the safe name search is performed according to the rest standard (search="search word") offset (number) offset of the first safe that is returned in the collection of results limit (number) the maximum number of safes that are returned sort (string) sorts according to the safename property in ascending order (default) or descending order to control the sort direction includeaccounts (boolean) whether or not to return accounts for each safe as part of the response extendeddetails (boolean) whether or not to return all safe details or only safename as part of the response output example \[ { "status code" 200, "response headers" {}, "reason" "success", "json body" { "value" \[ { "safeurlid" "vaultinternal", "safename" "vaultinternal", "safenumber" 2, "description" "", "location" "\\\\", "creator" { "id" "2", "name" "administrator" }, "olacenabled" false, "managingcpm" "", "numberofversionsretention" null, "numberofdaysretention" 30, "autopurgeenabled" false, "creationtime" 1608827926, "lastmodificationtime" 1610319618268452, "isexpiredmember" false } ], "count" 1769, "nextlink" "api/safes?offset=25\&limit=25\&usecache=false" } } ] output parameters status code (number) reason (string) json body (object) value (array) safeurlid (string) safename (string) safenumber (number) description (string) location (string) creator (object) id (string) name (string) olacenabled (boolean) managingcpm (string) numberofversionsretention (object) numberofdaysretention (number) autopurgeenabled (boolean) creationtime (number) lastmodificationtime (number) isexpiredmember (boolean) count (number) nextlink (string)