How to get started using the API to query the Vault?

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Announcements

Welcome Idira to LIVEcommunity!

Our community just got stronger! Explore new identity security resources, connect with experts, and discover more ways to learn and collaborate.

Meet Idira

How to get started using the API to query the Vault?

L2 Linker

I'm trying to test out the API tool to query the Vault (at least that is my starting point) but I'm a complete novice to using API and a bit lost, so looking for some clues to get started. I have found the swagger pages in the PVWA, which looks very useful, but I'm still a bit lost on how to apply it.

 

Eg,

How would I get a dump of all the accounts in the Vault?

Or a dump of accounts with a 'failed' status and the reason for the failure?

 

Can this be done in a single line URL via the browser, or does it need to be stepped through a script - eg. python or powershell?

Where does it need to run from? Any workstation, or from the component server?

 

A simple working example would be great, too.

 

Thanks for any help.

 

3 REPLIES 3

L6 Presenter

I think you cannot do it in single line url via browser, because before you can do query accounr, you must be authenticated to get token. this token will be pass for another task via restapi.

Check official sample script here : https://github.com/cyberark/epv-api-scripts

L4 Transporter

Hi Rodney, There is multiple method to utilize REST API call .but if you want to achieve certain function which requires combining multiple APIs, it does requires you to have some scripting skill . examples have been given by Heron.

 

To test the function of individual API, postman is commonly used tool. Please search " How to test REST API using Postman" from support portal. It will take you to article 000005143

L2 Linker

Thanks for the tips. I will check these out.

 

  • 671 Views
  • 3 replies
  • 0 Likes
Like what you see?

Show your appreciation!

Click Like if a post is helpful to you or if you just want to show your support.

Click Accept as Solution to acknowledge that the answer to your question has been provided.

The button appears next to the replies on topics you’ve started. The member who gave the solution and all future visitors to this topic will appreciate it!

These simple actions take just seconds of your time, but go a long way in showing appreciation for community members and the LIVEcommunity as a whole!

The LIVEcommunity thanks you for your participation!