Is there a command or way to know the API Version I'm using in my CyberArk PAS?

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

Is there a command or way to know the API Version I'm using in my CyberArk PAS?

L2 Linker
6 REPLIES 6

L3 Networker

Are you trying to get the version of CyberArk via the API or wanting to know which version of the API you are consuming?

 

If the former, use https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/Server%20Web%20Services%20-%20Server.htm?tocpath=Developer%7CREST%20APIs%7CServer%7C_____3 and if the later, you can identify the version 1 API it looks something like https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/ while v2 looks something like https://<IIS_Server_Ip>/PasswordVault/API.

I just want to know which version of API I'm using.

Thanks

L6 Presenter

Hi @Isaac Vasquez​,

 

normally the latest available version is used.

 

Use https://IP//PasswordVault/swagger for access to REST API informations Page and, next go to Web Services Documentation Page.

 

API versioning, if I remember correctly, is used in older versions (eg. 10.x) https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/10.10/en/Content/WebServices/APIVersioning.htm

 

Nino

L0 Member

@Antonino Bambino​  - So if I am a developer, using the CyberArk (self-hosted) API, how do I make sure my code will work during the upgrade cycle, when multiple versions will be present? One way is to have the code to detect the server version. For example.

  1. I can write my code, to create ClientModule_v1 module for CyberArk 12.x.
  2. If CyberArk 13.x has breaking API change, I will write another client module, ClientModule_v2.
  3. Then, I can write my code to automatically detect and load/use ClientModule_v1, or ClientModule_v2, based on CyberArk version.
  4. So that is the purpose of detecting CyberArk version, without logging in, since the logon API call itself can change.

 

Do you know of a way to do that?

 

Thanks

Yansheng

There is an API for that: Server | CyberArk Docs

L0 Member

@Pete Maan​ - Thank you for the quick reply. The "Server" endpoint is almost perfect.

  • If I am logged in, and logout, the `/PasswordVault/WebServices/PIMServices.svc/Server` continues to be accessible.
  • But if I haven't logged in, and don't have a token, it fails. with `CAIWS001E`

Is there an API endpoint that don't require any authentication?

 

Thanks

Yansheng

  • 441 Views
  • 6 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!