Delphix Products

 View Only
  • 1.  Get API Version or Base URL programmatically

    Posted 08-24-2022 09:38:00 PM

    Hi All,

    We are doing automation using Delphix APIs and would like to share those automation scripts. A challenge that we faced is, we had to change the base URL as the delphix engine versions are different. Is there a way we can get the API version or the base URL using the Delphix Engine IP ?

    I found that https://<masking engine IP>/resources/json/delphix/about returns us build version & api version. But the Output we get for API Version is 

            "apiVersion": {
                "type": "APIVersion",
                "major": 1,
                "minor": 11,
                "micro": 13
            }
    Output for Build Version is -

    "buildVersion": {
                "type": "VersionInfo",
                "major": 6,
                "minor": 0,
                "micro": 13,
                "patch": 0
            }

    while we expected the output to be 5.11.13. Will it be ideal that we always add "4" to the major API Version ? Or Subtract "1" from major Build Version ?
    Thank you in advance


    Regards,


    ------------------------------
    Ruchit Doshi
    ------------------------------


  • 2.  RE: Get API Version or Base URL programmatically
    Best Answer

    Posted 08-25-2022 08:57:00 AM
    Hi Ruchit-

    It looks like you're accessing the Virtualization (Continuous Data) API version, which may not be intentional as you reference masking engine IP in your question as well, so I assume you're trying to locate that info for Masking (Continuous Compliance).  These APIs are distinct.

    In both cases, the API version is not guaranteed to increment with the Engine version, so actively querying is probably ideal.  From the Masking API documentation, we find latestApiVersion under SystemInformation endpoint.  The following Documentation pages should help:

    https://maskingdocs.delphix.com/maskingApiEndpoints/5_1_15_maskingApiEndpoints.html

    https://maskingdocs.delphix.com/Delphix_Masking_APIs/Masking_Client/Masking_API_Client/

    There should be no 'transformation' or 'translation' of API versions, and they are not directly tied to the buildVersion; the explicit version will be indicated in this endpoint

    I hope this helps! If you have other specific questions please let us know.

    ------------------------------
    Sean Nothdurft
    Senior Principal Technical Support Engineer
    Delphix
    ------------------------------



  • 3.  RE: Get API Version or Base URL programmatically

    Posted 08-26-2022 12:18:00 AM
    Hi Sean,


    Thank you so much for your response. It worked for me

    Thank you once again

    Regards

    ------------------------------
    Ruchit Doshi
    ------------------------------